diff --git a/docs/backend_api/.nojekyll b/docs/Script API/.nojekyll similarity index 100% rename from docs/backend_api/.nojekyll rename to docs/Script API/.nojekyll diff --git a/docs/backend_api/assets/hierarchy.js b/docs/Script API/assets/hierarchy.js similarity index 100% rename from docs/backend_api/assets/hierarchy.js rename to docs/Script API/assets/hierarchy.js diff --git a/docs/backend_api/assets/highlight.css b/docs/Script API/assets/highlight.css similarity index 100% rename from docs/backend_api/assets/highlight.css rename to docs/Script API/assets/highlight.css diff --git a/docs/backend_api/assets/icons.js b/docs/Script API/assets/icons.js similarity index 100% rename from docs/backend_api/assets/icons.js rename to docs/Script API/assets/icons.js diff --git a/docs/backend_api/assets/icons.svg b/docs/Script API/assets/icons.svg similarity index 100% rename from docs/backend_api/assets/icons.svg rename to docs/Script API/assets/icons.svg diff --git a/docs/backend_api/assets/main.js b/docs/Script API/assets/main.js similarity index 100% rename from docs/backend_api/assets/main.js rename to docs/Script API/assets/main.js diff --git a/docs/backend_api/assets/navigation.js b/docs/Script API/assets/navigation.js similarity index 100% rename from docs/backend_api/assets/navigation.js rename to docs/Script API/assets/navigation.js diff --git a/docs/backend_api/assets/search.js b/docs/Script API/assets/search.js similarity index 100% rename from docs/backend_api/assets/search.js rename to docs/Script API/assets/search.js diff --git a/docs/backend_api/assets/style.css b/docs/Script API/assets/style.css similarity index 100% rename from docs/backend_api/assets/style.css rename to docs/Script API/assets/style.css diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.AbstractBeccaEntity.html b/docs/Script API/classes/Backend_Script_API._internal_.AbstractBeccaEntity.html similarity index 94% rename from docs/backend_api/classes/Backend_Script_API._internal_.AbstractBeccaEntity.html rename to docs/Script API/classes/Backend_Script_API._internal_.AbstractBeccaEntity.html index d8545f710..db6aaa5db 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.AbstractBeccaEntity.html +++ b/docs/Script API/classes/Backend_Script_API._internal_.AbstractBeccaEntity.html @@ -1,5 +1,5 @@ AbstractBeccaEntity | trilium
trilium
    Preparing search index...

    Class AbstractBeccaEntity<T>Abstract

    Base class for all backend entities.

    -

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor +

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    blobId? dateCreated? dateModified? @@ -23,7 +23,7 @@ putEntityChange save updateFromRow -

    Constructors

    Properties

    blobId?: string
    dateCreated?: string
    dateModified?: string
    isProtected?: boolean
    isSynced?: boolean
    utcDateCreated: string
    utcDateModified?: string

    Accessors

    Methods

    Protected_getContent

    Protected_setContent

    • Mark the entity as (soft) deleted. It will be completely erased later.

      +

    Constructors

    Properties

    blobId?: string
    dateCreated?: string
    dateModified?: string
    isProtected?: boolean
    isSynced?: boolean
    utcDateCreated: string
    utcDateModified?: string

    Accessors

    Methods

    Protected_getContent

    Protected_setContent

    • 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

      • deleteId: null | string = null

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.AsyncResource.html b/docs/Script API/classes/Backend_Script_API._internal_.AsyncResource.html similarity index 100% rename from docs/backend_api/classes/Backend_Script_API._internal_.AsyncResource.html rename to docs/Script API/classes/Backend_Script_API._internal_.AsyncResource.html diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.Axios.html b/docs/Script API/classes/Backend_Script_API._internal_.Axios.html similarity index 100% rename from docs/backend_api/classes/Backend_Script_API._internal_.Axios.html rename to docs/Script API/classes/Backend_Script_API._internal_.Axios.html diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.AxiosError.html b/docs/Script API/classes/Backend_Script_API._internal_.AxiosError.html similarity index 100% rename from docs/backend_api/classes/Backend_Script_API._internal_.AxiosError.html rename to docs/Script API/classes/Backend_Script_API._internal_.AxiosError.html diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.AxiosHeaders.html b/docs/Script API/classes/Backend_Script_API._internal_.AxiosHeaders.html similarity index 100% rename from docs/backend_api/classes/Backend_Script_API._internal_.AxiosHeaders.html rename to docs/Script API/classes/Backend_Script_API._internal_.AxiosHeaders.html diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.BAttachment.html b/docs/Script API/classes/Backend_Script_API._internal_.BAttachment.html similarity index 95% rename from docs/backend_api/classes/Backend_Script_API._internal_.BAttachment.html rename to docs/Script API/classes/Backend_Script_API._internal_.BAttachment.html index c4b0b7638..622f7a933 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.BAttachment.html +++ b/docs/Script API/classes/Backend_Script_API._internal_.BAttachment.html @@ -1,6 +1,6 @@ BAttachment | trilium
    trilium
      Preparing search index...

      Class BAttachment

      Attachment represent data related/attached to the note. Conceptually similar to attributes, but intended for larger amounts of data and generally not accessible to the user.

      -

      Hierarchy (View Summary)

      Index

      Constructors

      constructor +

      Hierarchy (View Summary)

      Index

      Constructors

      constructor

      Properties

      attachmentId? blobId? contentLength? @@ -47,10 +47,10 @@ larger amounts of data and generally not accessible to the user.

      save setContent updateFromRow -

      Constructors

      Properties

      attachmentId?: string
      blobId?: string
      contentLength?: number

      optionally added to the entity

      -
      dateCreated?: string
      dateModified?: string
      isDecrypted?: boolean
      isProtected?: boolean
      isSynced?: boolean
      mime: string
      noteId?: number
      ownerId: string

      either noteId or revisionId to which this attachment belongs

      -
      position?: number
      role: string
      title: string
      type?: "image" | "file"
      utcDateCreated: string
      utcDateModified?: string
      utcDateScheduledForErasureSince?: null | string

      Accessors

      Methods

      Protected_getContent

      Protected_setContent

      • Returns {
            attachmentId: undefined | string;
            blobId: undefined | string;
            contentLength: undefined | number;
            dateModified: undefined | string;
            isDeleted: boolean;
            isProtected: boolean;
            mime: string;
            ownerId: string;
            position: undefined | number;
            role: string;
            title: undefined | string;
            utcDateModified: undefined | string;
            utcDateScheduledForErasureSince: undefined | null | string;
        }

      • Returns {
            attachmentId: undefined | string;
            blobId: undefined | string;
            contentLength: undefined | number;
            dateModified: undefined | string;
            isDeleted: boolean;
            isProtected: boolean;
            mime: string;
            ownerId: string;
            position: undefined | number;
            role: string;
            title: undefined | string;
            utcDateModified: undefined | string;
            utcDateScheduledForErasureSince: undefined | null | string;
        }

      • Mark the entity as (soft) deleted. It will be completely erased later.

        +

      Constructors

      Properties

      attachmentId?: string
      blobId?: string
      contentLength?: number

      optionally added to the entity

      +
      dateCreated?: string
      dateModified?: string
      isDecrypted?: boolean
      isProtected?: boolean
      isSynced?: boolean
      mime: string
      noteId?: number
      ownerId: string

      either noteId or revisionId to which this attachment belongs

      +
      position?: number
      role: string
      title: string
      type?: "image" | "file"
      utcDateCreated: string
      utcDateModified?: string
      utcDateScheduledForErasureSince?: null | string

      Accessors

      Methods

      Protected_getContent

      Protected_setContent

      • Returns {
            attachmentId: undefined | string;
            blobId: undefined | string;
            contentLength: undefined | number;
            dateModified: undefined | string;
            isDeleted: boolean;
            isProtected: boolean;
            mime: string;
            ownerId: string;
            position: undefined | number;
            role: string;
            title: undefined | string;
            utcDateModified: undefined | string;
            utcDateScheduledForErasureSince: undefined | null | string;
        }

      • Returns {
            attachmentId: undefined | string;
            blobId: undefined | string;
            contentLength: undefined | number;
            dateModified: undefined | string;
            isDeleted: boolean;
            isProtected: boolean;
            mime: string;
            ownerId: string;
            position: undefined | number;
            role: string;
            title: undefined | string;
            utcDateModified: undefined | string;
            utcDateScheduledForErasureSince: undefined | null | string;
        }

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Accessors
      Methods
      +

      Parameters

      Returns void

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Accessors
      Methods
      diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.BAttribute.html b/docs/Script API/classes/Backend_Script_API._internal_.BAttribute.html similarity index 94% rename from docs/backend_api/classes/Backend_Script_API._internal_.BAttribute.html rename to docs/Script API/classes/Backend_Script_API._internal_.BAttribute.html index 068f1e3ad..e76650040 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.BAttribute.html +++ b/docs/Script API/classes/Backend_Script_API._internal_.BAttribute.html @@ -1,6 +1,6 @@ BAttribute | trilium
      trilium
        Preparing search index...

        Class BAttribute

        Attribute is an abstract concept which has two real uses - label (key - value pair) and relation (representing named relationship between source and target note)

        -

        Hierarchy (View Summary)

        Index

        Constructors

        constructor +

        Hierarchy (View Summary)

        Index

        Constructors

        constructor

        Properties

        attributeId blobId? dateCreated? @@ -47,7 +47,7 @@ and relation (representing named relationship between source and target note)

        update updateFromRow validate -

        Constructors

        Properties

        attributeId: string
        blobId?: string
        dateCreated?: string
        dateModified?: string
        isInheritable: boolean
        isProtected?: boolean
        isSynced?: boolean
        name: string
        noteId: string
        position: number
        type: AttributeType
        utcDateCreated: string
        utcDateModified?: string
        value: string

        Accessors

        Methods

        Protected_getContent

        Protected_setContent

        • Returns {
              attributeId: string;
              isDeleted: boolean;
              isInheritable: boolean;
              name: string;
              noteId: string;
              position: number;
              type: AttributeType;
              utcDateModified: undefined | string;
              value: string;
          }

        • Mark the entity as (soft) deleted. It will be completely erased later.

          +

        Constructors

        Properties

        attributeId: string
        blobId?: string
        dateCreated?: string
        dateModified?: string
        isInheritable: boolean
        isProtected?: boolean
        isSynced?: boolean
        name: string
        noteId: string
        position: number
        type: AttributeType
        utcDateCreated: string
        utcDateModified?: string
        value: string

        Accessors

        Methods

        Protected_getContent

        Protected_setContent

        • Returns {
              attributeId: string;
              isDeleted: boolean;
              isInheritable: boolean;
              name: string;
              noteId: string;
              position: number;
              type: AttributeType;
              utcDateModified: undefined | string;
              value: string;
          }

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        Parameters

        Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.BBranch.html b/docs/Script API/classes/Backend_Script_API._internal_.BBranch.html similarity index 95% rename from docs/backend_api/classes/Backend_Script_API._internal_.BBranch.html rename to docs/Script API/classes/Backend_Script_API._internal_.BBranch.html index 11e717966..01f4f4ddb 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.BBranch.html +++ b/docs/Script API/classes/Backend_Script_API._internal_.BBranch.html @@ -2,7 +2,7 @@ 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.

        -

        Hierarchy (View Summary)

        Index

        Constructors

        constructor +

        Hierarchy (View Summary)

        Index

        Constructors

        constructor

        Properties

        blobId? branchId? dateCreated? @@ -42,16 +42,16 @@ Always check noteId instead.

        save update updateFromRow -

        Constructors

        Properties

        blobId?: string
        branchId?: string
        dateCreated?: string
        dateModified?: string
        isExpanded: boolean
        isProtected?: boolean
        isSynced?: boolean
        noteId: string
        notePosition: number
        parentNoteId: string
        prefix: null | string
        utcDateCreated: string
        utcDateModified?: string

        Accessors

        • get isWeak(): boolean

          Branch is weak when its existence should not hinder deletion of its note. +

        Constructors

        Properties

        blobId?: string
        branchId?: string
        dateCreated?: string
        dateModified?: string
        isExpanded: boolean
        isProtected?: boolean
        isSynced?: boolean
        noteId: string
        notePosition: number
        parentNoteId: string
        prefix: null | string
        utcDateCreated: string
        utcDateModified?: string

        Accessors

        • get isWeak(): boolean

          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.

          -

          Returns boolean

        Methods

        Protected_getContent

        Protected_setContent

        Methods

        Protected_getContent

        Protected_setContent

        • Delete a branch. If this is a last note's branch, delete the note as well.

          Parameters

          • OptionaldeleteId: string

            optional delete identified

          • OptionaltaskContext: TaskContext

          Returns boolean

          true if note has been deleted, false otherwise

          -

        • Returns {
              branchId: undefined | string;
              isDeleted: boolean;
              isExpanded: boolean;
              noteId: string;
              notePosition: number;
              parentNoteId: string;
              prefix: null | string;
              utcDateModified: undefined | string;
          }

        • Returns {
              branchId: undefined | string;
              isDeleted: boolean;
              isExpanded: boolean;
              noteId: string;
              notePosition: number;
              parentNoteId: string;
              prefix: null | string;
              utcDateModified: undefined | string;
          }

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        Parameters

        Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.BEtapiToken.html b/docs/Script API/classes/Backend_Script_API._internal_.BEtapiToken.html similarity index 95% rename from docs/backend_api/classes/Backend_Script_API._internal_.BEtapiToken.html rename to docs/Script API/classes/Backend_Script_API._internal_.BEtapiToken.html index d60989931..d4e606f0d 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.BEtapiToken.html +++ b/docs/Script API/classes/Backend_Script_API._internal_.BEtapiToken.html @@ -6,7 +6,7 @@ Used by:

        The format user is presented with is "_". This is also called "authToken" to distinguish it from tokenHash and token.

        -

        Hierarchy (View Summary)

        Index

        Constructors

        constructor +

        Hierarchy (View Summary)

        Index

        Constructors

        constructor

        Properties

        blobId? dateCreated? dateModified? @@ -36,7 +36,7 @@ from tokenHash and token.

        putEntityChange save updateFromRow -

        Constructors

        Properties

        blobId?: string
        dateCreated?: string
        dateModified?: string
        etapiTokenId?: string
        isProtected?: boolean
        isSynced?: boolean
        name: string
        tokenHash: string
        utcDateCreated: string
        utcDateModified?: string

        Accessors

        Methods

        Protected_getContent

        Protected_setContent

        • Returns {
              etapiTokenId: undefined | string;
              isDeleted: boolean;
              name: string;
              tokenHash: string;
              utcDateCreated: string;
              utcDateModified: undefined | string;
          }

        • Mark the entity as (soft) deleted. It will be completely erased later.

          +

        Constructors

        Properties

        blobId?: string
        dateCreated?: string
        dateModified?: string
        etapiTokenId?: string
        isProtected?: boolean
        isSynced?: boolean
        name: string
        tokenHash: string
        utcDateCreated: string
        utcDateModified?: string

        Accessors

        Methods

        Protected_getContent

        Protected_setContent

        • Returns {
              etapiTokenId: undefined | string;
              isDeleted: boolean;
              name: string;
              tokenHash: string;
              utcDateCreated: string;
              utcDateModified: undefined | string;
          }

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        +

        Parameters

        Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods
        diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.BNote.html b/docs/Script API/classes/Backend_Script_API._internal_.BNote.html similarity index 95% rename from docs/backend_api/classes/Backend_Script_API._internal_.BNote.html rename to docs/Script API/classes/Backend_Script_API._internal_.BNote.html index d5c2baa91..3e5e6bff3 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.BNote.html +++ b/docs/Script API/classes/Backend_Script_API._internal_.BNote.html @@ -1,5 +1,5 @@ BNote | trilium
        trilium
          Preparing search index...

          Class BNote

          Trilium's main entity, which can represent text note, image, code note, file attachment etc.

          -

          Hierarchy (View Summary)

          Index

          Constructors

          constructor +

          Hierarchy (View Summary)

          Index

          Constructors

          constructor

          Properties

          __flatTextCache blobId? children @@ -172,23 +172,23 @@ toggleRelation update updateFromRow -

          Constructors

          Properties

          __flatTextCache

          __flatTextCache: null | string
          blobId?: string
          children: BNote[]
          contentAndAttachmentsAndRevisionsSize: null | number

          size of the note content, attachment contents and revision contents in bytes

          -
          contentAndAttachmentsSize: null | number

          size of the note content, attachment contents in bytes

          -
          contentSize: null | number

          size of the content in bytes

          -
          dateCreated?: string
          dateModified?: string
          isBeingDeleted: boolean

          set during the deletion operation, before it is completed (removed from becca completely).

          -
          isDecrypted: boolean
          isProtected?: boolean
          isSynced?: boolean
          mime: string
          noteId: string
          ownedAttributes: BAttribute[]
          parentBranches: BBranch[]
          parents: BNote[]
          revisionCount: null | number

          number of note revisions for this note

          -
          targetRelations: BAttribute[]
          title: string
          type:
              | "canvas"
              | "code"
              | "search"
              | "image"
              | "text"
              | "file"
              | "noteMap"
              | "launcher"
              | "doc"
              | "contentWidget"
              | "relationMap"
              | "render"
              | "mermaid"
              | "book"
              | "webView"
              | "mindMap"
              | "geoMap"
          utcDateCreated: string
          utcDateModified?: string

          Accessors

          Methods

          __validateTypeName

          • __validateTypeName(type?: null | string, name?: null | string): void

            Parameters

            • Optionaltype: null | string
            • Optionalname: null | string

            Returns void

          Protected_getContent

          Protected_setContent

          • Adds a new attribute to this note. The attribute is saved and returned. +

          Constructors

          Properties

          __flatTextCache

          __flatTextCache: null | string
          blobId?: string
          children: BNote[]
          contentAndAttachmentsAndRevisionsSize: null | number

          size of the note content, attachment contents and revision contents in bytes

          +
          contentAndAttachmentsSize: null | number

          size of the note content, attachment contents in bytes

          +
          contentSize: null | number

          size of the content in bytes

          +
          dateCreated?: string
          dateModified?: string
          isBeingDeleted: boolean

          set during the deletion operation, before it is completed (removed from becca completely).

          +
          isDecrypted: boolean
          isProtected?: boolean
          isSynced?: boolean
          mime: string
          noteId: string
          ownedAttributes: BAttribute[]
          parentBranches: BBranch[]
          parents: BNote[]
          revisionCount: null | number

          number of note revisions for this note

          +
          targetRelations: BAttribute[]
          title: string
          type:
              | "canvas"
              | "code"
              | "search"
              | "image"
              | "text"
              | "file"
              | "noteMap"
              | "launcher"
              | "doc"
              | "contentWidget"
              | "relationMap"
              | "render"
              | "mermaid"
              | "book"
              | "webView"
              | "mindMap"
              | "geoMap"
          utcDateCreated: string
          utcDateModified?: string

          Accessors

          Methods

          __validateTypeName

          • __validateTypeName(type?: null | string, name?: null | string): void

            Parameters

            • Optionaltype: null | string
            • Optionalname: null | string

            Returns void

          Protected_getContent

          Protected_setContent

          • Adds a new attribute to this note. The attribute is saved and returned. See addLabel, addRelation for more specific methods.

            Parameters

            • type: AttributeType

              attribute type (label / relation)

            • name: string

              name of the attribute, not including the leading ~/#

            • value: string = ""

              value of the attribute - text for labels, target note ID for relations; optional.

              -
            • isInheritable: boolean = false
            • position: null | number = null

            Returns BAttribute

          • Adds a new label to this note. The label attribute is saved and returned.

            +
          • isInheritable: boolean = false
          • position: null | number = null

          Returns BAttribute

          Returns BAttribute

          Returns BAttribute

          Returns void

          Returns void

          Returns void

          Returns BAttachment

          Returns void

          Returns void

          Returns void

          Returns void

          Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Accessors
          Methods
          __validateTypeName_getContent_setContentaddAttributeaddLabeladdRelationareAllNotePathsArchivedbeforeSavingcloneToconvertToParentAttachmentdecryptdeleteNoteeraseExcessRevisionSnapshotsgenerateHashgetAllNotePathsgetAncestorNoteIdsgetAncestorsgetAttachmentByIdgetAttachmentByTitlegetAttachmentsgetAttachmentsByRolegetAttributegetAttributeCaseInsensitivegetAttributesgetAttributeValuegetBestNotePathgetBestNotePathStringgetBranchesgetChildBranchesgetChildNotesgetContentgetDescendantNoteIdsgetDistanceToAncestorgetFileNamegetFilteredChildBranchesgetFlatTextgetIcongetInheritingNotesgetJsonContentgetJsonContentSafelygetLabelgetLabelDefinitionsgetLabelsgetLabelValuegetLabelValuesgetOwnedAttributegetOwnedAttributesgetOwnedAttributeValuegetOwnedLabelgetOwnedLabelsgetOwnedLabelValuegetOwnedLabelValuesgetOwnedRelationgetOwnedRelationsgetOwnedRelationValuegetParentBranchesgetParentNotesgetPojogetPojoToSavegetRelationgetRelationDefinitionsgetRelationsgetRelationTargetgetRelationValuegetRevisionsgetScriptEnvgetSearchResultNotesgetSortedNotePathRecordsgetStrongParentBranchesgetSubtreegetSubtreeNoteIdsgetSubtreeNotesIncludingTemplatedgetTargetRelationsgetTitleOrProtectedgetUtcDateChangedhasAncestorhasAttributehasChildrenhasInheritableArchivedLabelhasLabelhasOwnedAttributehasOwnedLabelhasOwnedRelationhasRelationhasStringContentinitinvalidateSubTreeinvalidateThisCacheisContentAvailableisDescendantOfNoteisEligibleForConversionToAttachmentisFolderisHiddenCompletelyisHtmlisImageisInheritedisInHiddenSubtreeisJavaScriptisJsonisLabelTruthyisLaunchBarConfigisOptionsisRootisStringNotemarkAsDeletedmarkAsDeletedSimpleputEntityChangeremoveAttributeremoveLabelremoveRelationsavesaveAttachmentsaveRevisionsearchNoteInSubtreesearchNotesInSubtreesetAttributesetContentsetJsonContentsetLabelsetRelationsortChildrensortParentstoggleAttributetoggleLabeltoggleRelationupdateupdateFromRow
          +

          Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Accessors
          Methods
          __validateTypeName_getContent_setContentaddAttributeaddLabeladdRelationareAllNotePathsArchivedbeforeSavingcloneToconvertToParentAttachmentdecryptdeleteNoteeraseExcessRevisionSnapshotsgenerateHashgetAllNotePathsgetAncestorNoteIdsgetAncestorsgetAttachmentByIdgetAttachmentByTitlegetAttachmentsgetAttachmentsByRolegetAttributegetAttributeCaseInsensitivegetAttributesgetAttributeValuegetBestNotePathgetBestNotePathStringgetBranchesgetChildBranchesgetChildNotesgetContentgetDescendantNoteIdsgetDistanceToAncestorgetFileNamegetFilteredChildBranchesgetFlatTextgetIcongetInheritingNotesgetJsonContentgetJsonContentSafelygetLabelgetLabelDefinitionsgetLabelsgetLabelValuegetLabelValuesgetOwnedAttributegetOwnedAttributesgetOwnedAttributeValuegetOwnedLabelgetOwnedLabelsgetOwnedLabelValuegetOwnedLabelValuesgetOwnedRelationgetOwnedRelationsgetOwnedRelationValuegetParentBranchesgetParentNotesgetPojogetPojoToSavegetRelationgetRelationDefinitionsgetRelationsgetRelationTargetgetRelationValuegetRevisionsgetScriptEnvgetSearchResultNotesgetSortedNotePathRecordsgetStrongParentBranchesgetSubtreegetSubtreeNoteIdsgetSubtreeNotesIncludingTemplatedgetTargetRelationsgetTitleOrProtectedgetUtcDateChangedhasAncestorhasAttributehasChildrenhasInheritableArchivedLabelhasLabelhasOwnedAttributehasOwnedLabelhasOwnedRelationhasRelationhasStringContentinitinvalidateSubTreeinvalidateThisCacheisContentAvailableisDescendantOfNoteisEligibleForConversionToAttachmentisFolderisHiddenCompletelyisHtmlisImageisInheritedisInHiddenSubtreeisJavaScriptisJsonisLabelTruthyisLaunchBarConfigisOptionsisRootisStringNotemarkAsDeletedmarkAsDeletedSimpleputEntityChangeremoveAttributeremoveLabelremoveRelationsavesaveAttachmentsaveRevisionsearchNoteInSubtreesearchNotesInSubtreesetAttributesetContentsetJsonContentsetLabelsetRelationsortChildrensortParentstoggleAttributetoggleLabeltoggleRelationupdateupdateFromRow
          diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.BOption.html b/docs/Script API/classes/Backend_Script_API._internal_.BOption.html similarity index 95% rename from docs/backend_api/classes/Backend_Script_API._internal_.BOption.html rename to docs/Script API/classes/Backend_Script_API._internal_.BOption.html index c6b6d4246..e409b1aef 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.BOption.html +++ b/docs/Script API/classes/Backend_Script_API._internal_.BOption.html @@ -1,5 +1,5 @@ BOption | trilium
          trilium
            Preparing search index...

            Class BOption

            Option represents a name-value pair, either directly configurable by the user or some system property.

            -

            Hierarchy (View Summary)

            Index

            Constructors

            constructor +

            Hierarchy (View Summary)

            Index

            Constructors

            constructor

            Properties

            blobId? dateCreated? dateModified? @@ -28,7 +28,7 @@ putEntityChange save updateFromRow -

            Constructors

            Properties

            blobId?: string
            dateCreated?: string
            dateModified?: string
            isProtected?: boolean
            isSynced?: boolean
            name: string
            utcDateCreated: string
            utcDateModified?: string
            value: string

            Accessors

            Methods

            Protected_getContent

            Protected_setContent

            • Returns {
                  isSynced: undefined | boolean;
                  name: string;
                  utcDateModified: undefined | string;
                  value: string;
              }

            • Mark the entity as (soft) deleted. It will be completely erased later.

              +

            Constructors

            Properties

            blobId?: string
            dateCreated?: string
            dateModified?: string
            isProtected?: boolean
            isSynced?: boolean
            name: string
            utcDateCreated: string
            utcDateModified?: string
            value: string

            Accessors

            Methods

            Protected_getContent

            Protected_setContent

            • Returns {
                  isSynced: undefined | boolean;
                  name: string;
                  utcDateModified: undefined | string;
                  value: string;
              }

            Settings

            Member Visibility

            On This Page

            Constructors
            Properties
            Accessors
            Methods
            +

            Parameters

            Returns void

            Settings

            Member Visibility

            On This Page

            Constructors
            Properties
            Accessors
            Methods
            diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.BRevision.html b/docs/Script API/classes/Backend_Script_API._internal_.BRevision.html similarity index 96% rename from docs/backend_api/classes/Backend_Script_API._internal_.BRevision.html rename to docs/Script API/classes/Backend_Script_API._internal_.BRevision.html index bb1eea714..d87e5fb71 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.BRevision.html +++ b/docs/Script API/classes/Backend_Script_API._internal_.BRevision.html @@ -1,6 +1,6 @@ BRevision | trilium
            trilium
              Preparing search index...

              Class BRevision

              Revision represents a snapshot of note's title and content at some point in the past. It's used for seamless note versioning.

              -

              Hierarchy (View Summary)

              Index

              Constructors

              constructor +

              Hierarchy (View Summary)

              Index

              Constructors

              constructor

              Properties

              blobId? content? contentLength? @@ -47,11 +47,11 @@ It's used for seamless note versioning.

              save setContent updateFromRow -

              Constructors

              Properties

              blobId?: string

              Optionalcontent

              content?: string | Buffer<ArrayBufferLike>
              contentLength?: number
              dateCreated?: string
              dateLastEdited?: string
              dateModified?: string
              isProtected?: boolean
              isSynced?: boolean
              mime: string
              noteId: string
              revisionId?: string
              title: string
              type:
                  | "canvas"
                  | "code"
                  | "search"
                  | "image"
                  | "text"
                  | "file"
                  | "noteMap"
                  | "launcher"
                  | "doc"
                  | "contentWidget"
                  | "relationMap"
                  | "render"
                  | "mermaid"
                  | "book"
                  | "webView"
                  | "mindMap"
                  | "geoMap"
              utcDateCreated: string
              utcDateLastEdited?: string
              utcDateModified?: string

              Accessors

              Methods

              Protected_getContent

              Protected_setContent

              • Returns {
                    blobId: undefined | string;
                    content: undefined | string | Buffer<ArrayBufferLike>;
                    contentLength: undefined | number;
                    dateCreated: undefined | string;
                    dateLastEdited: undefined | string;
                    isProtected: undefined | boolean;
                    mime: string;
                    noteId: string;
                    revisionId: undefined | string;
                    title: undefined | string;
                    type:
                        | "canvas"
                        | "code"
                        | "search"
                        | "image"
                        | "text"
                        | "file"
                        | "noteMap"
                        | "launcher"
                        | "doc"
                        | "contentWidget"
                        | "relationMap"
                        | "render"
                        | "mermaid"
                        | "book"
                        | "webView"
                        | "mindMap"
                        | "geoMap";
                    utcDateCreated: string;
                    utcDateLastEdited: undefined
                    | string;
                    utcDateModified: undefined | string;
                }

              • Returns {
                    blobId: undefined | string;
                    content: undefined | string | Buffer<ArrayBufferLike>;
                    contentLength: undefined | number;
                    dateCreated: undefined | string;
                    dateLastEdited: undefined | string;
                    isProtected: undefined | boolean;
                    mime: string;
                    noteId: string;
                    revisionId: undefined | string;
                    title: undefined | string;
                    type:
                        | "canvas"
                        | "code"
                        | "search"
                        | "image"
                        | "text"
                        | "file"
                        | "noteMap"
                        | "launcher"
                        | "doc"
                        | "contentWidget"
                        | "relationMap"
                        | "render"
                        | "mermaid"
                        | "book"
                        | "webView"
                        | "mindMap"
                        | "geoMap";
                    utcDateCreated: string;
                    utcDateLastEdited: undefined
                    | string;
                    utcDateModified: undefined | string;
                }

              • Mark the entity as (soft) deleted. It will be completely erased later.

                +

              Constructors

              Properties

              blobId?: string

              Optionalcontent

              content?: string | Buffer<ArrayBufferLike>
              contentLength?: number
              dateCreated?: string
              dateLastEdited?: string
              dateModified?: string
              isProtected?: boolean
              isSynced?: boolean
              mime: string
              noteId: string
              revisionId?: string
              title: string
              type:
                  | "canvas"
                  | "code"
                  | "search"
                  | "image"
                  | "text"
                  | "file"
                  | "noteMap"
                  | "launcher"
                  | "doc"
                  | "contentWidget"
                  | "relationMap"
                  | "render"
                  | "mermaid"
                  | "book"
                  | "webView"
                  | "mindMap"
                  | "geoMap"
              utcDateCreated: string
              utcDateLastEdited?: string
              utcDateModified?: string

              Accessors

              Methods

              Protected_getContent

              Protected_setContent

              • Returns {
                    blobId: undefined | string;
                    content: undefined | string | Buffer<ArrayBufferLike>;
                    contentLength: undefined | number;
                    dateCreated: undefined | string;
                    dateLastEdited: undefined | string;
                    isProtected: undefined | boolean;
                    mime: string;
                    noteId: string;
                    revisionId: undefined | string;
                    title: undefined | string;
                    type:
                        | "canvas"
                        | "code"
                        | "search"
                        | "image"
                        | "text"
                        | "file"
                        | "noteMap"
                        | "launcher"
                        | "doc"
                        | "contentWidget"
                        | "relationMap"
                        | "render"
                        | "mermaid"
                        | "book"
                        | "webView"
                        | "mindMap"
                        | "geoMap";
                    utcDateCreated: string;
                    utcDateLastEdited: undefined
                    | string;
                    utcDateModified: undefined | string;
                }

              • Returns {
                    blobId: undefined | string;
                    content: undefined | string | Buffer<ArrayBufferLike>;
                    contentLength: undefined | number;
                    dateCreated: undefined | string;
                    dateLastEdited: undefined | string;
                    isProtected: undefined | boolean;
                    mime: string;
                    noteId: string;
                    revisionId: undefined | string;
                    title: undefined | string;
                    type:
                        | "canvas"
                        | "code"
                        | "search"
                        | "image"
                        | "text"
                        | "file"
                        | "noteMap"
                        | "launcher"
                        | "doc"
                        | "contentWidget"
                        | "relationMap"
                        | "render"
                        | "mermaid"
                        | "book"
                        | "webView"
                        | "mindMap"
                        | "geoMap";
                    utcDateCreated: string;
                    utcDateLastEdited: undefined
                    | string;
                    utcDateModified: undefined | string;
                }

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Accessors
              Methods
              +

              Parameters

              Returns void

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Accessors
              Methods
              diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.CanceledError.html b/docs/Script API/classes/Backend_Script_API._internal_.CanceledError.html similarity index 100% rename from docs/backend_api/classes/Backend_Script_API._internal_.CanceledError.html rename to docs/Script API/classes/Backend_Script_API._internal_.CanceledError.html diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResource.html b/docs/Script API/classes/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResource.html similarity index 100% rename from docs/backend_api/classes/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResource.html rename to docs/Script API/classes/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResource.html diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.EventEmitter.html b/docs/Script API/classes/Backend_Script_API._internal_.EventEmitter.html similarity index 100% rename from docs/backend_api/classes/Backend_Script_API._internal_.EventEmitter.html rename to docs/Script API/classes/Backend_Script_API._internal_.EventEmitter.html diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.SpacedUpdate.html b/docs/Script API/classes/Backend_Script_API._internal_.SpacedUpdate.html similarity index 96% rename from docs/backend_api/classes/Backend_Script_API._internal_.SpacedUpdate.html rename to docs/Script API/classes/Backend_Script_API._internal_.SpacedUpdate.html index 9b0a58b35..faffb25d9 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.SpacedUpdate.html +++ b/docs/Script API/classes/Backend_Script_API._internal_.SpacedUpdate.html @@ -1,7 +1,7 @@ -SpacedUpdate | trilium
              trilium
                Preparing search index...

                Class SpacedUpdate

                Index

                Constructors

                constructor +SpacedUpdate | trilium
                trilium
                  Preparing search index...

                  Class SpacedUpdate

                  Index

                  Constructors

                  constructor

                  Methods

                  allowUpdateWithoutChange isAllSavedAndTriggerUpdate scheduleUpdate triggerUpdate updateNowIfNecessary -

                  Constructors

                  Methods

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Methods
                  +

                  Constructors

                  Methods

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Methods
                  diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.TaskContext.html b/docs/Script API/classes/Backend_Script_API._internal_.TaskContext.html similarity index 95% rename from docs/backend_api/classes/Backend_Script_API._internal_.TaskContext.html rename to docs/Script API/classes/Backend_Script_API._internal_.TaskContext.html index fe9698317..73914831e 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.TaskContext.html +++ b/docs/Script API/classes/Backend_Script_API._internal_.TaskContext.html @@ -1,8 +1,8 @@ -TaskContext | trilium
                  trilium
                    Preparing search index...

                    Class TaskContext

                    Index

                    Constructors

                    constructor +TaskContext | trilium
                    trilium
                      Preparing search index...

                      Class TaskContext

                      Index

                      Constructors

                      constructor

                      Properties

                      data noteDeletionHandlerTriggered

                      Methods

                      increaseProgressCount reportError taskSucceeded getInstance -

                      Constructors

                      Properties

                      data: null | TaskData
                      noteDeletionHandlerTriggered: boolean

                      Methods

                      Settings

                      Member Visibility

                      On This Page

                      Constructors
                      Properties
                      Methods
                      +

                      Constructors

                      Properties

                      data: null | TaskData
                      noteDeletionHandlerTriggered: boolean

                      Methods

                      Settings

                      Member Visibility

                      On This Page

                      Constructors
                      Properties
                      Methods
                      diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.default.html b/docs/Script API/classes/Backend_Script_API._internal_.default.html similarity index 95% rename from docs/backend_api/classes/Backend_Script_API._internal_.default.html rename to docs/Script API/classes/Backend_Script_API._internal_.default.html index 3a3d898cb..4708c58dd 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.default.html +++ b/docs/Script API/classes/Backend_Script_API._internal_.default.html @@ -1,6 +1,6 @@ default | trilium
                      trilium
                        Preparing search index...

                        Class default

                        Becca is a backend cache of all notes, branches, and attributes. There's a similar frontend cache Froca, and share cache Shaca.

                        -
                        Index

                        Constructors

                        constructor +
                        Index

                        Constructors

                        constructor

                        Properties

                        allNoteSetCache attributeIndex attributes @@ -38,6 +38,6 @@ There's a similar frontend cache Froca, and share cache Shaca.

                        getRevisionsFromQuery getRoot reset -

                        Constructors

                        Properties

                        allNoteSetCache: null | NoteSet
                        attributeIndex: Record<string, BAttribute[]>

                        Points from attribute type-name to list of attributes

                        -
                        attributes: Record<string, BAttribute>
                        branches: Record<string, BBranch>
                        childParentToBranch: Record<string, BBranch>
                        etapiTokens: Record<string, BEtapiToken>
                        loaded: boolean
                        notes: Record<string, BNote>
                        options: Record<string, BOption>

                        Methods

                        • Should be called when the set of all non-skeleton notes changes (added/removed)

                          -

                          Returns void

                        • Parameters

                          • query: string
                          • params: string[] = []

                          Returns BRecentNote[]

                        Settings

                        Member Visibility

                        On This Page

                        Constructors
                        Properties
                        Methods
                        +

                        Constructors

                        Properties

                        allNoteSetCache: null | NoteSet
                        attributeIndex: Record<string, BAttribute[]>

                        Points from attribute type-name to list of attributes

                        +
                        attributes: Record<string, BAttribute>
                        branches: Record<string, BBranch>
                        childParentToBranch: Record<string, BBranch>
                        etapiTokens: Record<string, BEtapiToken>
                        loaded: boolean
                        notes: Record<string, BNote>
                        options: Record<string, BOption>

                        Methods

                        • Should be called when the set of all non-skeleton notes changes (added/removed)

                          +

                          Returns void

                        • Parameters

                          • query: string
                          • params: string[] = []

                          Returns BRecentNote[]

                        Settings

                        Member Visibility

                        On This Page

                        Constructors
                        Properties
                        Methods
                        diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.node_modules__types_xml2js.Builder.html b/docs/Script API/classes/Backend_Script_API._internal_.node_modules__types_xml2js.Builder.html similarity index 100% rename from docs/backend_api/classes/Backend_Script_API._internal_.node_modules__types_xml2js.Builder.html rename to docs/Script API/classes/Backend_Script_API._internal_.node_modules__types_xml2js.Builder.html diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.node_modules__types_xml2js.Parser.html b/docs/Script API/classes/Backend_Script_API._internal_.node_modules__types_xml2js.Parser.html similarity index 100% rename from docs/backend_api/classes/Backend_Script_API._internal_.node_modules__types_xml2js.Parser.html rename to docs/Script API/classes/Backend_Script_API._internal_.node_modules__types_xml2js.Parser.html diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.node_modules__types_xml2js.ValidationError.html b/docs/Script API/classes/Backend_Script_API._internal_.node_modules__types_xml2js.ValidationError.html similarity index 100% rename from docs/backend_api/classes/Backend_Script_API._internal_.node_modules__types_xml2js.ValidationError.html rename to docs/Script API/classes/Backend_Script_API._internal_.node_modules__types_xml2js.ValidationError.html diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.FAttachment.html b/docs/Script API/classes/Frontend_Script_API._internal_.FAttachment.html similarity index 95% rename from docs/backend_api/classes/Frontend_Script_API._internal_.FAttachment.html rename to docs/Script API/classes/Frontend_Script_API._internal_.FAttachment.html index 7d8e71360..897c816d8 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.FAttachment.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.FAttachment.html @@ -1,6 +1,6 @@ FAttachment | trilium
                        trilium
                          Preparing search index...

                          Class FAttachment

                          Attachment is a file directly tied into a note without being a hidden child.

                          -
                          Index

                          Constructors

                          constructor +
                          Index

                          Constructors

                          constructor

                          Properties

                          attachmentId contentLength isProtected @@ -13,5 +13,5 @@ being a hidden child.

                          Methods

                          getBlob getNote update -

                          Constructors

                          Properties

                          attachmentId: string
                          contentLength: number

                          optionally added to the entity

                          -
                          isProtected: boolean
                          mime: string
                          ownerId: string
                          role: string
                          title: string
                          utcDateModified: string
                          utcDateScheduledForErasureSince: string

                          Methods

                          Settings

                          Member Visibility

                          On This Page

                          Constructors
                          Properties
                          Methods
                          +

                          Constructors

                          Properties

                          attachmentId: string
                          contentLength: number

                          optionally added to the entity

                          +
                          isProtected: boolean
                          mime: string
                          ownerId: string
                          role: string
                          title: string
                          utcDateModified: string
                          utcDateScheduledForErasureSince: string

                          Methods

                          Settings

                          Member Visibility

                          On This Page

                          Constructors
                          Properties
                          Methods
                          diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.FAttribute.html b/docs/Script API/classes/Frontend_Script_API._internal_.FAttribute.html similarity index 94% rename from docs/backend_api/classes/Frontend_Script_API._internal_.FAttribute.html rename to docs/Script API/classes/Frontend_Script_API._internal_.FAttribute.html index aa4c6c554..ebc9c181d 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.FAttribute.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.FAttribute.html @@ -1,6 +1,6 @@ FAttribute | trilium
                          trilium
                            Preparing search index...

                            Class FAttribute

                            Attribute is an abstract concept which has two real uses - label (key - value pair) and relation (representing named relationship between source and target note)

                            -
                            Index

                            Constructors

                            constructor +
                            Index

                            Constructors

                            constructor

                            Properties

                            attributeId isInheritable name @@ -18,4 +18,4 @@ and relation (representing named relationship between source and target note)

                            isDefinition isDefinitionFor update -

                            Constructors

                            Properties

                            attributeId: string
                            isInheritable: boolean
                            name: string
                            noteId: string
                            position: number
                            type: AttributeType
                            value: string

                            Accessors

                            Methods

                            Settings

                            Member Visibility

                            On This Page

                            Constructors
                            Properties
                            Accessors
                            Methods
                            +

                            Constructors

                            Properties

                            attributeId: string
                            isInheritable: boolean
                            name: string
                            noteId: string
                            position: number
                            type: AttributeType
                            value: string

                            Accessors

                            Methods

                            Settings

                            Member Visibility

                            On This Page

                            Constructors
                            Properties
                            Accessors
                            Methods
                            diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.FBranch.html b/docs/Script API/classes/Frontend_Script_API._internal_.FBranch.html similarity index 95% rename from docs/backend_api/classes/Frontend_Script_API._internal_.FBranch.html rename to docs/Script API/classes/Frontend_Script_API._internal_.FBranch.html index 383f8c629..40cd586f6 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.FBranch.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.FBranch.html @@ -1,6 +1,6 @@ FBranch | trilium
                            trilium
                              Preparing search index...

                              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 +
                              Index

                              Constructors

                              constructor

                              Properties

                              branchId fromSearchNote isExpanded? @@ -15,6 +15,6 @@ parents.

                              getParentNote isTopLevel update -

                              Constructors

                              Properties

                              branchId: string

                              primary key

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

                              Accessors

                              Methods

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              Accessors
                              Methods
                              +

                              Constructors

                              Properties

                              branchId: string

                              primary key

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

                              Accessors

                              Methods

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              Accessors
                              Methods
                              diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.FNote.html b/docs/Script API/classes/Frontend_Script_API._internal_.FNote.html similarity index 95% rename from docs/backend_api/classes/Frontend_Script_API._internal_.FNote.html rename to docs/Script API/classes/Frontend_Script_API._internal_.FNote.html index ed5438004..61b3ba4ba 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.FNote.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.FNote.html @@ -1,5 +1,5 @@ FNote | trilium
                              trilium
                                Preparing search index...

                                Class FNote

                                Note is the main node and concept in Trilium.

                                -
                                Index

                                Constructors

                                constructor +
                                Index

                                Constructors

                                constructor

                                Properties

                                attachments attributes blobId @@ -100,82 +100,82 @@ 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)

                                  +

                                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

                                  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

                                • 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
                                +

                                Settings

                                Member Visibility

                                On This Page

                                Constructors
                                Properties
                                Accessors
                                Methods
                                __getInheritableAttributes__validateTypeNameaddChildaddParentexecuteScriptgetAllNotePathsgetAttachmentByIdgetAttachmentsgetAttachmentsByRolegetAttributegetAttributesgetAttributeValuegetBestNotePathgetBestNotePathStringgetBlobgetBranchesgetBranchIdsgetChildBranchesgetChildNoteIdsgetChildNotesgetColorClassgetContentgetCssClassgetFilteredChildBranchesgetIcongetJsonContentgetLabelgetLabelsgetLabelValuegetMetadatagetNoteComplementgetNotesToInheritAttributesFromgetOwnedAttributegetOwnedAttributesgetOwnedAttributeValuegetOwnedLabelgetOwnedLabelsgetOwnedLabelValuegetOwnedRelationgetOwnedRelationsgetOwnedRelationValuegetParentBranchesgetParentBranchIdsgetParentNoteIdsgetParentNotesgetPromotedDefinitionAttributesgetRelationgetRelationsgetRelationTargetgetRelationTargetsgetRelationValuegetScriptEnvgetSortedNotePathRecordsgetTargetRelationsgetTargetRelationSourceNotesgetWorkspaceIconClassgetWorkspaceTabBackgroundColorhasAncestorhasAttributehasChildrenhasLabelhasOwnedAttributehasOwnedLabelhasOwnedRelationhasRelationinvalidateAttributeCacheisContentAvailableisEligibleForConversionToAttachmentisFolderisHiddenCompletelyisHtmlisInHiddenSubtreeisJavaScriptisJsonisLabelTruthyisLaunchBarConfigisOptionsisRootisSharedsortChildrensortParentstoStringupdate
                                diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.NoteContext.html b/docs/Script API/classes/Frontend_Script_API._internal_.NoteContext.html similarity index 95% rename from docs/backend_api/classes/Frontend_Script_API._internal_.NoteContext.html rename to docs/Script API/classes/Frontend_Script_API._internal_.NoteContext.html index a600dc67d..3e2f3bc4d 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.NoteContext.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.NoteContext.html @@ -8,7 +8,7 @@ other components.
                              • although the execution is async, we are collecting all the promises, and therefore it is possible to wait until the event / command is executed in all components - by simply awaiting the triggerEvent().
                                • -

                                Hierarchy (View Summary)

                                Implements

                                Index

                                Constructors

                                constructor +

                                Hierarchy (View Summary)

                                Implements

                                Index

                                Constructors

                                constructor

                                Properties

                                _position $widget children @@ -57,15 +57,15 @@ event / command is executed in all components - by simply awaiting the tri triggerEvent unhoist generateNtxId -

                                Constructors

                                Properties

                                _position

                                _position: number
                                $widget: JQuery<HTMLElement>
                                children: default[]
                                componentId: string
                                hoistedNoteId: string
                                initialized: null | Promise<void>
                                mainNtxId: null | string
                                noteId?: null | string
                                notePath?: null | string
                                ntxId: null | string
                                parent?: TypedComponent<any>
                                parentNoteId?: null | string
                                viewScope?: ViewScope

                                Accessors

                                Methods

                                • Parameters

                                  • fun: (arg: unknown) => Promise<unknown>
                                  • data: unknown

                                  Returns undefined | Promise<unknown>

                                • Returns a promise which will retrieve the JQuery element of the content of this note context.

                                  +

                                Constructors

                                Properties

                                _position

                                _position: number
                                $widget: JQuery<HTMLElement>
                                children: default[]
                                componentId: string
                                hoistedNoteId: string
                                initialized: null | Promise<void>
                                mainNtxId: null | string
                                noteId?: null | string
                                notePath?: null | string
                                ntxId: null | string
                                parent?: TypedComponent<any>
                                parentNoteId?: null | string
                                viewScope?: ViewScope

                                Accessors

                                Methods

                                • Parameters

                                  • fun: (arg: unknown) => Promise<unknown>
                                  • data: unknown

                                  Returns undefined | Promise<unknown>

                                • Returns a promise which will retrieve the JQuery element of the content of this note context.

                                  Do note that retrieving the content element needs to be handled by the type widget, which is the one which provides the content element by listening to the executeWithContentElement event. Not all note types support this.

                                  If no content could be determined null is returned instead.

                                  -

                                  Returns Promise<JQuery<HTMLElement>>

                                • Returns
                                      | null
                                      | {
                                          active: boolean;
                                          hoistedNoteId: string;
                                          mainNtxId: null
                                          | string;
                                          notePath: undefined | null | string;
                                          ntxId: null | string;
                                          viewScope: undefined | ViewScope;
                                      }

                                • A main context represents a tab and also the first split. Further splits are the children contexts of the main context. +

                                  Returns Promise<JQuery<HTMLElement>>

                                • Returns
                                      | null
                                      | {
                                          active: boolean;
                                          hoistedNoteId: string;
                                          mainNtxId: null
                                          | string;
                                          notePath: undefined | null | string;
                                          ntxId: null | string;
                                          viewScope: undefined | ViewScope;
                                      }

                                • A main context represents a tab and also the first split. Further splits are the children contexts of the main context. Imagine you have a tab with 3 splits, each showing notes A, B, C (in this order). In such a scenario, A context is the main context (also representing the tab as a whole), and B, C are the children of context A.

                                  Returns boolean

                                  true if the context is main (= tab)

                                  -

                                Settings

                                Member Visibility

                                On This Page

                                Constructors
                                Properties
                                Accessors
                                Methods
                                +

                                Settings

                                Member Visibility

                                On This Page

                                Constructors
                                Properties
                                Accessors
                                Methods
                                diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.NoteContextAwareWidget.html b/docs/Script API/classes/Frontend_Script_API._internal_.NoteContextAwareWidget.html similarity index 95% rename from docs/backend_api/classes/Frontend_Script_API._internal_.NoteContextAwareWidget.html rename to docs/Script API/classes/Frontend_Script_API._internal_.NoteContextAwareWidget.html index fba427ba3..7c25747a9 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.NoteContextAwareWidget.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.NoteContextAwareWidget.html @@ -1,5 +1,5 @@ NoteContextAwareWidget | trilium
                                trilium
                                  Preparing search index...

                                  Class NoteContextAwareWidget

                                  This widget allows for changing and updating depending on the active note.

                                  -

                                  Hierarchy (View Summary)

                                  Index

                                  Constructors

                                  constructor +

                                  Hierarchy (View Summary)

                                  Index

                                  Constructors

                                  constructor

                                  Properties

                                  _noteId _position $widget @@ -59,26 +59,26 @@ toggleInt triggerCommand triggerEvent -

                                  Constructors

                                  Properties

                                  _noteId

                                  _noteId: string

                                  _position

                                  _position: number
                                  $widget: JQuery<HTMLElement>
                                  attrs: Record<string, string>
                                  children: default[]
                                  componentId: string
                                  initialized: null | Promise<void>
                                  noteContext?: NoteContext
                                  parent?: TypedComponent<any>

                                  Accessors

                                  Methods

                                  • Parameters

                                    • fun: (arg: unknown) => Promise<unknown>
                                    • data: unknown

                                    Returns undefined | Promise<unknown>

                                  • Sets the CSS attribute of the given name to the given value.

                                    +

                                  Constructors

                                  Properties

                                  _noteId

                                  _noteId: string

                                  _position

                                  _position: number
                                  $widget: JQuery<HTMLElement>
                                  attrs: Record<string, string>
                                  children: default[]
                                  componentId: string
                                  initialized: null | Promise<void>
                                  noteContext?: NoteContext
                                  parent?: TypedComponent<any>

                                  Accessors

                                  Methods

                                  • Parameters

                                    • fun: (arg: unknown) => Promise<unknown>
                                    • data: unknown

                                    Returns undefined | Promise<unknown>

                                  • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                    +

                                    Returns void

                                  • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                    If the widget is not enabled, it will not receive `refreshWithNote` updates.

                                    Returns undefined | null | boolean

                                    true when an active note exists

                                    -

                                  • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                    Parameters

                                    • condition: boolean

                                      true in order to apply the CSS, false to ignore it.

                                    • name: string

                                      the name of the CSS attribute to set (e.g. padding-left).

                                    • value: string

                                      the value of the CSS attribute to set (e.g. 12px).

                                    Returns NoteContextAwareWidget

                                    self for chaining.

                                    -

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Constructors
                                  Properties
                                  Accessors
                                  Methods
                                  +

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Constructors
                                  Properties
                                  Accessors
                                  Methods
                                  diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.RightPanelWidget.html b/docs/Script API/classes/Frontend_Script_API._internal_.RightPanelWidget.html similarity index 95% rename from docs/backend_api/classes/Frontend_Script_API._internal_.RightPanelWidget.html rename to docs/Script API/classes/Frontend_Script_API._internal_.RightPanelWidget.html index b63e746cf..bfe2b90b2 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.RightPanelWidget.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.RightPanelWidget.html @@ -1,5 +1,5 @@ RightPanelWidget | trilium
                                  trilium
                                    Preparing search index...

                                    Class RightPanelWidget

                                    This widget manages rendering panels in the right-hand pane.

                                    -

                                    Hierarchy (View Summary)

                                    Index

                                    Constructors

                                    constructor +

                                    Hierarchy (View Summary)

                                    Index

                                    Constructors

                                    constructor

                                    Properties

                                    _noteId _position $body @@ -64,29 +64,29 @@ toggleInt triggerCommand triggerEvent -

                                    Constructors

                                    Properties

                                    _noteId

                                    _noteId: string

                                    _position

                                    _position: number

                                    $body

                                    $body: JQuery<HTMLElement>
                                    $widget: JQuery<HTMLElement>
                                    attrs: Record<string, string>
                                    children: default[]
                                    componentId: string
                                    initialized: null | Promise<void>
                                    noteContext?: NoteContext
                                    parent?: TypedComponent<any>

                                    Accessors

                                    Methods

                                    • Sets the CSS attribute of the given name to the given value.

                                      +

                                    Constructors

                                    Properties

                                    _noteId

                                    _noteId: string

                                    _position

                                    _position: number

                                    $body

                                    $body: JQuery<HTMLElement>
                                    $widget: JQuery<HTMLElement>
                                    attrs: Record<string, string>
                                    children: default[]
                                    componentId: string
                                    initialized: null | Promise<void>
                                    noteContext?: NoteContext
                                    parent?: TypedComponent<any>

                                    Accessors

                                    Methods

                                    • Method used for rendering the body of the widget (via existing this.$body)

                                      Your class should override this method.

                                      Returns Promise<void>

                                      if widget needs async operation to initialize, it can return a Promise

                                      -

                                    • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                      +

                                    • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                      If the widget is not enabled, it will not receive `refreshWithNote` updates.

                                      Returns undefined | null | boolean

                                      true when an active note exists

                                      -

                                    • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                      Parameters

                                      • condition: boolean

                                        true in order to apply the CSS, false to ignore it.

                                      • name: string

                                        the name of the CSS attribute to set (e.g. padding-left).

                                      • value: string

                                        the value of the CSS attribute to set (e.g. 12px).

                                      Returns RightPanelWidget

                                      self for chaining.

                                      -

                                    Settings

                                    Member Visibility

                                    On This Page

                                    Constructors
                                    Properties
                                    Accessors
                                    Methods
                                    +

                                    Settings

                                    Member Visibility

                                    On This Page

                                    Constructors
                                    Properties
                                    Accessors
                                    Methods
                                    diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.TypedComponent.html b/docs/Script API/classes/Frontend_Script_API._internal_.TypedComponent.html similarity index 96% rename from docs/backend_api/classes/Frontend_Script_API._internal_.TypedComponent.html rename to docs/Script API/classes/Frontend_Script_API._internal_.TypedComponent.html index f75df9005..05850526c 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.TypedComponent.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.TypedComponent.html @@ -8,7 +8,7 @@ other components.
                                  • although the execution is async, we are collecting all the promises, and therefore it is possible to wait until the event / command is executed in all components - by simply awaiting the triggerEvent().
                                    • -

                                    Type Parameters

                                    Hierarchy (View Summary)

                                    Index

                                    Constructors

                                    constructor +

                                    Type Parameters

                                    Hierarchy (View Summary)

                                    Index

                                    Constructors

                                    constructor

                                    Properties

                                    _position $widget children @@ -24,4 +24,4 @@ event / command is executed in all components - by simply awaiting the tri setParent triggerCommand triggerEvent -

                                    Constructors

                                    Properties

                                    _position

                                    _position: number
                                    $widget: JQuery<HTMLElement>
                                    children: ChildT[]
                                    componentId: string
                                    initialized: null | Promise<void>
                                    parent?: TypedComponent<any>

                                    Accessors

                                    Methods

                                    • Parameters

                                      • fun: (arg: unknown) => Promise<unknown>
                                      • data: unknown

                                      Returns undefined | Promise<unknown>

                                    Settings

                                    Member Visibility

                                    On This Page

                                    Constructors
                                    Properties
                                    Accessors
                                    Methods
                                    +

                                    Constructors

                                    Properties

                                    _position

                                    _position: number
                                    $widget: JQuery<HTMLElement>
                                    children: ChildT[]
                                    componentId: string
                                    initialized: null | Promise<void>
                                    parent?: TypedComponent<any>

                                    Accessors

                                    Methods

                                    • Parameters

                                      • fun: (arg: unknown) => Promise<unknown>
                                      • data: unknown

                                      Returns undefined | Promise<unknown>

                                    Settings

                                    Member Visibility

                                    On This Page

                                    Constructors
                                    Properties
                                    Accessors
                                    Methods
                                    diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-1.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-1.html similarity index 95% rename from docs/backend_api/classes/Frontend_Script_API._internal_.default-1.html rename to docs/Script API/classes/Frontend_Script_API._internal_.default-1.html index d39722a1d..3dc2e4e23 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.default-1.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default-1.html @@ -1,5 +1,5 @@ default | trilium
                                    trilium
                                      Preparing search index...

                                      Class default

                                      This widget allows for changing and updating depending on the active note.

                                      -

                                      Hierarchy (View Summary)

                                      Index

                                      Constructors

                                      constructor +

                                      Hierarchy (View Summary)

                                      Index

                                      Constructors

                                      constructor

                                      Properties

                                      _noteId _position $widget @@ -78,27 +78,27 @@ toggleInt triggerCommand triggerEvent -

                                      Constructors

                                      Properties

                                      _noteId

                                      _noteId: string

                                      _position

                                      _position: number
                                      $widget: JQuery<HTMLElement>
                                      attrs: Record<string, string>
                                      children: default[]
                                      componentId: string
                                      initialized: null | Promise<void>
                                      noteContext?: NoteContext
                                      parent?: TypedComponent<any>

                                      Accessors

                                      Methods

                                      • Parameters

                                        • __namedParameters: { ntxIds: string[] }

                                        Returns Promise<void>

                                      • Sets the CSS attribute of the given name to the given value.

                                        +

                                      Constructors

                                      Properties

                                      _noteId

                                      _noteId: string

                                      _position

                                      _position: number
                                      $widget: JQuery<HTMLElement>
                                      attrs: Record<string, string>
                                      children: default[]
                                      componentId: string
                                      initialized: null | Promise<void>
                                      noteContext?: NoteContext
                                      parent?: TypedComponent<any>

                                      Accessors

                                      Methods

                                      • Parameters

                                        • __namedParameters: { ntxIds: string[] }

                                        Returns Promise<void>

                                      • Parameters

                                        • __namedParameters: { noteId: string; ntxId: null | string }

                                        Returns void

                                      • Parameters

                                        • __namedParameters: { noteId: string; ntxId: null | string }

                                        Returns void

                                      • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                        If the widget is not enabled, it will not receive `refreshWithNote` updates.

                                        Returns boolean

                                        true when an active note exists

                                        -

                                      • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                        Parameters

                                        • condition: boolean

                                          true in order to apply the CSS, false to ignore it.

                                        • name: string

                                          the name of the CSS attribute to set (e.g. padding-left).

                                        • value: string

                                          the value of the CSS attribute to set (e.g. 12px).

                                        Returns default

                                        self for chaining.

                                        -

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Constructors
                                      Properties
                                      Accessors
                                      Methods
                                      activeContextChangedactiveContextChangedEventbeforeNoteContextRemoveEventbeforeNoteSwitchEventbeforeUnloadEventcallMethodcanBeShowncheckFullHeightchildclasscleanupcollapsiblecontentSizedcsscssBlockcutIntoNoteCommanddoRenderentitiesReloadedEventexecuteInActiveNoteDetailWidgetEventexecuteWithTypeWidgetEventexportAsPdfEventfillingfocusOnDetailEventfrocaReloadedEventgetClosestNtxIdgetPositiongetTypeWidgetgetWidgetTypehandleEventhandleEventInChildrenhoistedNoteChangedEventidisActiveNoteContextisEnabledisHiddenExtisHiddenIntisNoteisNoteContextisVisiblelogRenderingErrornoteSwitchednoteSwitchedAndActivatedEventnoteSwitchedEventnoteTypeMimeChangedEventoptChildoptCssprintActiveNoteEventreadOnlyTemporarilyDisabledEventrefreshrefreshWithNoteremoverenderrenderActiveNoteEventrunActiveNoteCommandsaveNoteDetailNowCommandscrollToEndEventsetNoteContextEventsetParenttoggleExttoggleInttriggerCommandtriggerEvent
                                      +

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Constructors
                                      Properties
                                      Accessors
                                      Methods
                                      activeContextChangedactiveContextChangedEventbeforeNoteContextRemoveEventbeforeNoteSwitchEventbeforeUnloadEventcallMethodcanBeShowncheckFullHeightchildclasscleanupcollapsiblecontentSizedcsscssBlockcutIntoNoteCommanddoRenderentitiesReloadedEventexecuteInActiveNoteDetailWidgetEventexecuteWithTypeWidgetEventexportAsPdfEventfillingfocusOnDetailEventfrocaReloadedEventgetClosestNtxIdgetPositiongetTypeWidgetgetWidgetTypehandleEventhandleEventInChildrenhoistedNoteChangedEventidisActiveNoteContextisEnabledisHiddenExtisHiddenIntisNoteisNoteContextisVisiblelogRenderingErrornoteSwitchednoteSwitchedAndActivatedEventnoteSwitchedEventnoteTypeMimeChangedEventoptChildoptCssprintActiveNoteEventreadOnlyTemporarilyDisabledEventrefreshrefreshWithNoteremoverenderrenderActiveNoteEventrunActiveNoteCommandsaveNoteDetailNowCommandscrollToEndEventsetNoteContextEventsetParenttoggleExttoggleInttriggerCommandtriggerEvent
                                      diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-2.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-2.html similarity index 96% rename from docs/backend_api/classes/Frontend_Script_API._internal_.default-2.html rename to docs/Script API/classes/Frontend_Script_API._internal_.default-2.html index 3b126761b..ca88f90f0 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.default-2.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default-2.html @@ -8,7 +8,7 @@ other components.
                                    • although the execution is async, we are collecting all the promises, and therefore it is possible to wait until the event / command is executed in all components - by simply awaiting the triggerEvent().
                                      • -

                                      Hierarchy (View Summary)

                                      Index

                                      Constructors

                                      constructor +

                                      Hierarchy (View Summary)

                                      Index

                                      Constructors

                                      constructor

                                      Properties

                                      _position $widget children @@ -24,4 +24,4 @@ event / command is executed in all components - by simply awaiting the tri setParent triggerCommand triggerEvent -

                                      Constructors

                                      Properties

                                      _position

                                      _position: number
                                      $widget: JQuery<HTMLElement>
                                      children: default[]
                                      componentId: string
                                      initialized: null | Promise<void>
                                      parent?: TypedComponent<any>

                                      Accessors

                                      Methods

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Constructors
                                      Properties
                                      Accessors
                                      Methods
                                      +

                                      Constructors

                                      Properties

                                      _position

                                      _position: number
                                      $widget: JQuery<HTMLElement>
                                      children: default[]
                                      componentId: string
                                      initialized: null | Promise<void>
                                      parent?: TypedComponent<any>

                                      Accessors

                                      Methods

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Constructors
                                      Properties
                                      Accessors
                                      Methods
                                      diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-3.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-3.html similarity index 96% rename from docs/backend_api/classes/Frontend_Script_API._internal_.default-3.html rename to docs/Script API/classes/Frontend_Script_API._internal_.default-3.html index 3f3b16bf9..7bcad453a 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.default-3.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default-3.html @@ -1,10 +1,10 @@ -default | trilium
                                      trilium
                                        Preparing search index...

                                        Class default

                                        Index

                                        Constructors

                                        constructor +default | trilium
                                        trilium
                                          Preparing search index...

                                          Class default

                                          Index

                                          Constructors

                                          constructor

                                          Methods

                                          allowUpdateWithoutChange isAllSavedAndTriggerUpdate resetUpdateTimer scheduleUpdate triggerUpdate updateNowIfNecessary -

                                          Constructors

                                          Methods

                                          • Normally () would actually trigger the update only once per updateInterval. If the method is called 200 times within 20s, it will execute only 20 times. +

                                          Constructors

                                          Methods

                                          • Normally () would actually trigger the update only once per updateInterval. If the method is called 200 times within 20s, it will execute only 20 times. Sometimes, if the updates are continuous this would cause a performance impact. Resetting the time ensures that the calls to triggerUpdate have stopped before actually triggering an update.

                                            -

                                            Returns void

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Constructors
                                          Methods
                                          +

                                          Returns void

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Constructors
                                          Methods
                                          diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-4.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-4.html similarity index 95% rename from docs/backend_api/classes/Frontend_Script_API._internal_.default-4.html rename to docs/Script API/classes/Frontend_Script_API._internal_.default-4.html index 9067f9e43..c60e49c43 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.default-4.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default-4.html @@ -1,4 +1,4 @@ -default | trilium
                                          trilium
                                            Preparing search index...

                                            Class default

                                            Index

                                            Constructors

                                            constructor +default | trilium
                                            trilium
                                              Preparing search index...

                                              Class default

                                              Index

                                              Constructors

                                              constructor

                                              Properties

                                              blobId content contentLength @@ -6,6 +6,6 @@ utcDateModified

                                              Methods

                                              getJsonContent getJsonContentSafely -

                                              Constructors

                                              Properties

                                              blobId: string

                                              content

                                              content: string

                                              can either contain the whole content (in e.g. string notes), only part (large text notes) or nothing at all (binary notes, images)

                                              -
                                              contentLength: number
                                              dateModified: string
                                              utcDateModified: string

                                              Methods

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Constructors
                                              Properties
                                              Methods
                                              +

                                              Constructors

                                              Properties

                                              blobId: string

                                              content

                                              content: string

                                              can either contain the whole content (in e.g. string notes), only part (large text notes) or nothing at all (binary notes, images)

                                              +
                                              contentLength: number
                                              dateModified: string
                                              utcDateModified: string

                                              Methods

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Constructors
                                              Properties
                                              Methods
                                              diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-5.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-5.html similarity index 95% rename from docs/backend_api/classes/Frontend_Script_API._internal_.default-5.html rename to docs/Script API/classes/Frontend_Script_API._internal_.default-5.html index a3d90a461..38451c1cb 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.default-5.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default-5.html @@ -1,5 +1,5 @@ default | trilium
                                              trilium
                                                Preparing search index...

                                                Class default<SettingsT>

                                                This widget allows for changing and updating depending on the active note.

                                                -

                                                Type Parameters

                                                • SettingsT extends AbstractButtonWidgetSettings

                                                Hierarchy (View Summary)

                                                Index

                                                Constructors

                                                constructor +

                                                Type Parameters

                                                • SettingsT extends AbstractButtonWidgetSettings

                                                Hierarchy (View Summary)

                                                Index

                                                Constructors

                                                constructor

                                                Properties

                                                _noteId _position $widget @@ -68,26 +68,26 @@ toggleInt triggerCommand triggerEvent -

                                                Constructors

                                                Properties

                                                _noteId

                                                _noteId: string

                                                _position

                                                _position: number
                                                $widget: JQuery<HTMLElement>
                                                attrs: Record<string, string>
                                                children: default[]
                                                componentId: string
                                                initialized: null | Promise<void>
                                                noteContext?: NoteContext
                                                parent?: TypedComponent<any>
                                                settings: SettingsT
                                                tooltip: Tooltip

                                                Accessors

                                                Methods

                                                • Sets the CSS attribute of the given name to the given value.

                                                  +

                                                Constructors

                                                Properties

                                                _noteId

                                                _noteId: string

                                                _position

                                                _position: number
                                                $widget: JQuery<HTMLElement>
                                                attrs: Record<string, string>
                                                children: default[]
                                                componentId: string
                                                initialized: null | Promise<void>
                                                noteContext?: NoteContext
                                                parent?: TypedComponent<any>
                                                settings: SettingsT
                                                tooltip: Tooltip

                                                Accessors

                                                Methods

                                                • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                                  If the widget is not enabled, it will not receive `refreshWithNote` updates.

                                                  Returns undefined | null | boolean

                                                  true when an active note exists

                                                  -

                                                • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                                  Parameters

                                                  • condition: boolean

                                                    true in order to apply the CSS, false to ignore it.

                                                  • name: string

                                                    the name of the CSS attribute to set (e.g. padding-left).

                                                  • value: string

                                                    the value of the CSS attribute to set (e.g. 12px).

                                                  Returns default<SettingsT>

                                                  self for chaining.

                                                  -

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Constructors
                                                Properties
                                                Accessors
                                                Methods
                                                +

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Constructors
                                                Properties
                                                Accessors
                                                Methods
                                                diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-6.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-6.html similarity index 95% rename from docs/backend_api/classes/Frontend_Script_API._internal_.default-6.html rename to docs/Script API/classes/Frontend_Script_API._internal_.default-6.html index 16e447f30..308f97738 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.default-6.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default-6.html @@ -1,5 +1,5 @@ default | trilium
                                                trilium
                                                  Preparing search index...

                                                  Class defaultAbstract

                                                  The base class for all the note types.

                                                  -

                                                  Hierarchy (View Summary)

                                                  Index

                                                  Constructors

                                                  constructor +

                                                  Hierarchy (View Summary)

                                                  Index

                                                  Constructors

                                                  constructor

                                                  Properties

                                                  _noteId _position $widget @@ -68,33 +68,33 @@ triggerCommand triggerEvent getType -

                                                  Constructors

                                                  Properties

                                                  _noteId

                                                  _noteId: string

                                                  _position

                                                  _position: number
                                                  $widget: JQuery<HTMLElement>
                                                  attrs: Record<string, string>
                                                  children: default[]
                                                  componentId: string
                                                  initialized: null | Promise<void>
                                                  noteContext?: NoteContext
                                                  parent?: TypedComponent<any>
                                                  spacedUpdate: default

                                                  Accessors

                                                  Methods

                                                  • Sets the CSS attribute of the given name to the given value.

                                                    +

                                                  Constructors

                                                  Properties

                                                  _noteId

                                                  _noteId: string

                                                  _position

                                                  _position: number
                                                  $widget: JQuery<HTMLElement>
                                                  attrs: Record<string, string>
                                                  children: default[]
                                                  componentId: string
                                                  initialized: null | Promise<void>
                                                  noteContext?: NoteContext
                                                  parent?: TypedComponent<any>
                                                  spacedUpdate: default

                                                  Accessors

                                                  Methods

                                                  • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                                    If the widget is not enabled, it will not receive `refreshWithNote` updates.

                                                    Returns undefined | null | boolean

                                                    true when an active note exists

                                                    -

                                                  • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                                    Parameters

                                                    • condition: boolean

                                                      true in order to apply the CSS, false to ignore it.

                                                    • name: string

                                                      the name of the CSS attribute to set (e.g. padding-left).

                                                    • value: string

                                                      the value of the CSS attribute to set (e.g. 12px).

                                                    Returns default

                                                    self for chaining.

                                                    -

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Constructors
                                                  Properties
                                                  Accessors
                                                  Methods
                                                  +

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Constructors
                                                  Properties
                                                  Accessors
                                                  Methods
                                                  diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-7.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-7.html similarity index 95% rename from docs/backend_api/classes/Frontend_Script_API._internal_.default-7.html rename to docs/Script API/classes/Frontend_Script_API._internal_.default-7.html index 62ada970c..d47db1cb4 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.default-7.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default-7.html @@ -3,7 +3,7 @@
                                                • Ballon block mode, in which there is a floating toolbar for the selected text, but another floating button for the entire block (i.e. paragraph).
                                                • Decoupled mode, in which the editing toolbar is actually added on the client side (in ClassicEditorToolbar), see https://ckeditor.com/docs/ckeditor5/latest/examples/framework/bottom-toolbar-editor.html for an example on how the decoupled editor works.
                                                  • -

                                                  Hierarchy

                                                  • default
                                                    • default
                                                  Index

                                                  Constructors

                                                  constructor +

                                                  Hierarchy

                                                  • default
                                                    • default
                                                  Index

                                                  Constructors

                                                  constructor

                                                  Properties

                                                  _noteId _position $widget @@ -102,30 +102,30 @@ triggerCommand triggerEvent getType -

                                                  Constructors

                                                  Properties

                                                  _noteId

                                                  _noteId: string

                                                  _position

                                                  _position: number
                                                  $widget: JQuery<HTMLElement>
                                                  attrs: Record<string, string>
                                                  children: default[]
                                                  componentId: string
                                                  initialized: null | Promise<void>
                                                  noteContext?: NoteContext
                                                  parent?: TypedComponent<any>
                                                  spacedUpdate: default

                                                  Accessors

                                                  Methods

                                                  • Parameters

                                                    • notePath: string
                                                    • linkTitle: null | string
                                                    • externalLink: boolean = false

                                                    Returns Promise<void>

                                                  • Parameters

                                                    • fun: (arg: unknown) => Promise<unknown>
                                                    • data: unknown

                                                    Returns undefined | Promise<unknown>

                                                  • Sets the CSS attribute of the given name to the given value.

                                                    +

                                                  Constructors

                                                  Properties

                                                  _noteId

                                                  _noteId: string

                                                  _position

                                                  _position: number
                                                  $widget: JQuery<HTMLElement>
                                                  attrs: Record<string, string>
                                                  children: default[]
                                                  componentId: string
                                                  initialized: null | Promise<void>
                                                  noteContext?: NoteContext
                                                  parent?: TypedComponent<any>
                                                  spacedUpdate: default

                                                  Accessors

                                                  Methods

                                                  • Parameters

                                                    • notePath: string
                                                    • linkTitle: null | string
                                                    • externalLink: boolean = false

                                                    Returns Promise<void>

                                                  • Parameters

                                                    • fun: (arg: unknown) => Promise<unknown>
                                                    • data: unknown

                                                    Returns undefined | Promise<unknown>

                                                  • Sets the CSS attribute of the given name to the given value.

                                                    Parameters

                                                    • name: string

                                                      the name of the CSS attribute to set (e.g. padding-left).

                                                    • value: string

                                                      the value of the CSS attribute to set (e.g. 12px).

                                                    Returns default

                                                    self for chaining.

                                                    -

                                                  • By default:

                                                    • activeContextChanged is intercepted and converted to a setNoteContext event to avoid refresh().
                                                    • entitiesReloaded and refreshData are passed as-is.
                                                    • any other event is not passed to the children.
                                                    -

                                                    Type Parameters

                                                    Parameters

                                                    Returns null | Promise<unknown>

                                                  • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                                    +

                                                    Type Parameters

                                                    Parameters

                                                    Returns null | Promise<unknown>

                                                  • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                                    If the widget is not enabled, it will not receive `refreshWithNote` updates.

                                                    Returns undefined | null | boolean

                                                    true when an active note exists

                                                    -

                                                  • Parameters

                                                    • ntxId: undefined | null | string | string[]

                                                    Returns undefined | null | boolean | ""

                                                  • Parameters

                                                    • ntxId: undefined | null | string | string[]

                                                    Returns undefined | null | boolean | ""

                                                  • Conditionally adds the given components as children to this component.

                                                    Parameters

                                                    • condition: boolean

                                                      whether to add the components.

                                                    • ...components: default[]

                                                      the components to be added as children to this component provided the condition is truthy.

                                                    Returns default

                                                    self for chaining.

                                                    -

                                                  • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                                    +

                                                  • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                                    Parameters

                                                    • condition: boolean

                                                      true in order to apply the CSS, false to ignore it.

                                                    • name: string

                                                      the name of the CSS attribute to set (e.g. padding-left).

                                                    • value: string

                                                      the value of the CSS attribute to set (e.g. 12px).

                                                    Returns default

                                                    self for chaining.

                                                    -

                                                  • Parameters

                                                    • $img: JQuery<HTMLElement>

                                                    Returns Promise<
                                                        | null
                                                        | {
                                                            noteId: any;
                                                            viewScope: { attachmentId?: undefined; viewMode?: undefined };
                                                        }
                                                        | {
                                                            noteId: undefined
                                                            | string;
                                                            viewScope: { attachmentId: any; viewMode: string };
                                                        },
                                                    >

                                                  • Parameters

                                                    • show: undefined | null | boolean | ""

                                                    Returns void

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Constructors
                                                  Properties
                                                  Accessors
                                                  Methods
                                                  activeContextChangedactiveContextChangedEventaddImageaddIncludeNoteaddIncludeNoteToTextCommandaddLinkaddLinkToEditoraddLinkToTextCommandaddTextToActiveEditorEventaddTextToEditorcallMethodcanBeShownchildclasscleanupcollapsiblecontentSizedcreateEditorcreateNoteForReferenceLinkcsscssBlockdataSaveddoRefreshdoRenderentitiesReloadedEventexecuteWithTextEditorEventfillingfocusfollowLinkUnderCursorCommandfrocaReloadedEventgetClosestNtxIdgetDatagetEditorgetPositiongetSelectedTexthandleEventhandleEventInChildrenhasSelectionidinitEditorinsertDateTimeToTextCommandisActiveisActiveNoteContextisEnabledisHiddenExtisHiddenIntisNoteisNoteContextisVisibleloadIncludedNoteloadReferenceLinkTitlelogRenderingErrornoteSwitchednoteSwitchedAndActivatedEventnoteSwitchedEventnoteTypeMimeChangedEventonLanguageChangedopenImageInCurrentTabopenImageInNewTaboptChildoptCssparseFromImagereadOnlyTemporarilyDisabledEventrefreshrefreshCodeBlockOptionsrefreshIncludedNoterefreshIncludedNoteEventrefreshWithNotereinitializeremoverenderscrollToEndsetNoteContextEventsetParentsetupImageOpeningshowtoggleExttoggleInttriggerCommandtriggerEventgetType
                                                  +

                                                  • Parameters

                                                    • $img: JQuery<HTMLElement>

                                                    Returns Promise<
                                                        | null
                                                        | {
                                                            noteId: any;
                                                            viewScope: { attachmentId?: undefined; viewMode?: undefined };
                                                        }
                                                        | {
                                                            noteId: undefined
                                                            | string;
                                                            viewScope: { attachmentId: any; viewMode: string };
                                                        },
                                                    >

                                                  • Parameters

                                                    • show: undefined | null | boolean | ""

                                                    Returns void

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Constructors
                                                  Properties
                                                  Accessors
                                                  Methods
                                                  activeContextChangedactiveContextChangedEventaddImageaddIncludeNoteaddIncludeNoteToTextCommandaddLinkaddLinkToEditoraddLinkToTextCommandaddTextToActiveEditorEventaddTextToEditorcallMethodcanBeShownchildclasscleanupcollapsiblecontentSizedcreateEditorcreateNoteForReferenceLinkcsscssBlockdataSaveddoRefreshdoRenderentitiesReloadedEventexecuteWithTextEditorEventfillingfocusfollowLinkUnderCursorCommandfrocaReloadedEventgetClosestNtxIdgetDatagetEditorgetPositiongetSelectedTexthandleEventhandleEventInChildrenhasSelectionidinitEditorinsertDateTimeToTextCommandisActiveisActiveNoteContextisEnabledisHiddenExtisHiddenIntisNoteisNoteContextisVisibleloadIncludedNoteloadReferenceLinkTitlelogRenderingErrornoteSwitchednoteSwitchedAndActivatedEventnoteSwitchedEventnoteTypeMimeChangedEventonLanguageChangedopenImageInCurrentTabopenImageInNewTaboptChildoptCssparseFromImagereadOnlyTemporarilyDisabledEventrefreshrefreshCodeBlockOptionsrefreshIncludedNoterefreshIncludedNoteEventrefreshWithNotereinitializeremoverenderscrollToEndsetNoteContextEventsetParentsetupImageOpeningshowtoggleExttoggleInttriggerCommandtriggerEventgetType
                                                  diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-8.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-8.html similarity index 95% rename from docs/backend_api/classes/Frontend_Script_API._internal_.default-8.html rename to docs/Script API/classes/Frontend_Script_API._internal_.default-8.html index 66874db79..149ecc4ae 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.default-8.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default-8.html @@ -1,4 +1,4 @@ -default | trilium
                                                  trilium
                                                    Preparing search index...

                                                    Class default

                                                    Index

                                                    Constructors

                                                    constructor +default | trilium
                                                    trilium
                                                      Preparing search index...

                                                      Class default

                                                      Index

                                                      Constructors

                                                      constructor

                                                      Methods

                                                      addAttachmentRow addAttribute addBranch @@ -21,6 +21,6 @@ isNoteContentReloaded isNoteReloaded isOptionReloaded -

                                                      Constructors

                                                      Methods

                                                      • Parameters

                                                        • revisionId: string
                                                        • OptionalnoteId: string
                                                        • OptionalcomponentId: null | string

                                                        Returns void

                                                      • Type Parameters

                                                        • T extends keyof EntityRowMappings

                                                        Parameters

                                                        • entityName: T
                                                        • entityId: string

                                                        Returns EntityRowMappings[T]

                                                      • Returns boolean

                                                        true if there are changes which could affect the attributes (including inherited ones) +

                                                      Constructors

                                                      Methods

                                                      • Parameters

                                                        • revisionId: string
                                                        • OptionalnoteId: string
                                                        • OptionalcomponentId: null | string

                                                        Returns void

                                                      • Type Parameters

                                                        • T extends keyof EntityRowMappings

                                                        Parameters

                                                        • entityName: T
                                                        • entityId: string

                                                        Returns EntityRowMappings[T]

                                                      • Returns boolean

                                                        true if there are changes which could affect the attributes (including inherited ones) notably changes in note itself should not have any effect on attributes

                                                        -

                                                      • Parameters

                                                        • noteId: string
                                                        • OptionalcomponentId: string

                                                        Returns undefined | false | ContentNoteIdToComponentIdRow

                                                      • Parameters

                                                        • noteId: undefined | null | string
                                                        • componentId: null | string = null

                                                        Returns boolean

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Constructors
                                                      Methods
                                                      +

                                                      • Parameters

                                                        • noteId: string
                                                        • OptionalcomponentId: string

                                                        Returns undefined | false | ContentNoteIdToComponentIdRow

                                                      • Parameters

                                                        • noteId: undefined | null | string
                                                        • componentId: null | string = null

                                                        Returns boolean

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Constructors
                                                      Methods
                                                      diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default.html b/docs/Script API/classes/Frontend_Script_API._internal_.default.html similarity index 95% rename from docs/backend_api/classes/Frontend_Script_API._internal_.default.html rename to docs/Script API/classes/Frontend_Script_API._internal_.default.html index cc0522a80..8b6532a77 100644 --- a/docs/backend_api/classes/Frontend_Script_API._internal_.default.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default.html @@ -1,6 +1,6 @@ default | trilium
                                                      trilium
                                                        Preparing search index...

                                                        Class default

                                                        This is the base widget for all other widgets.

                                                        For information on using widgets, see the tutorial {@tutorial widget_basics}.

                                                        -

                                                        Hierarchy (View Summary)

                                                        Index

                                                        Constructors

                                                        constructor +

                                                        Hierarchy (View Summary)

                                                        Index

                                                        Constructors

                                                        constructor

                                                        Properties

                                                        _noteId _position $widget @@ -41,24 +41,24 @@ toggleInt triggerCommand triggerEvent -

                                                        Constructors

                                                        Properties

                                                        _noteId

                                                        _noteId: string

                                                        _position

                                                        _position: number
                                                        $widget: JQuery<HTMLElement>
                                                        attrs: Record<string, string>
                                                        children: default[]
                                                        componentId: string
                                                        initialized: null | Promise<void>
                                                        parent?: TypedComponent<any>

                                                        Accessors

                                                        Methods

                                                        • Parameters

                                                          • fun: (arg: unknown) => Promise<unknown>
                                                          • data: unknown

                                                          Returns undefined | Promise<unknown>

                                                        • Sets the CSS attribute of the given name to the given value.

                                                          +

                                                        Constructors

                                                        Properties

                                                        _noteId

                                                        _noteId: string

                                                        _position

                                                        _position: number
                                                        $widget: JQuery<HTMLElement>
                                                        attrs: Record<string, string>
                                                        children: default[]
                                                        componentId: string
                                                        initialized: null | Promise<void>
                                                        parent?: TypedComponent<any>

                                                        Accessors

                                                        Methods

                                                        • Parameters

                                                          • fun: (arg: unknown) => Promise<unknown>
                                                          • data: unknown

                                                          Returns undefined | Promise<unknown>

                                                        • Sets the CSS attribute of the given name to the given value.

                                                          Parameters

                                                          • name: string

                                                            the name of the CSS attribute to set (e.g. padding-left).

                                                          • value: string

                                                            the value of the CSS attribute to set (e.g. 12px).

                                                          Returns default

                                                          self for chaining.

                                                          -

                                                        • Method used for rendering the widget.

                                                          Your class should override this method. The method is expected to create a this.$widget containing jQuery object

                                                          -

                                                          Returns void

                                                        • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                                          +

                                                          Returns void

                                                        • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                                          Returns undefined | null | boolean

                                                          whether the widget is enabled.

                                                          -

                                                        • Conditionally adds the given components as children to this component.

                                                          Parameters

                                                          • condition: boolean

                                                            whether to add the components.

                                                          • ...components: default[]

                                                            the components to be added as children to this component provided the condition is truthy.

                                                          Returns default

                                                          self for chaining.

                                                          -

                                                        • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                                          +

                                                        • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                                          Parameters

                                                          • condition: boolean

                                                            true in order to apply the CSS, false to ignore it.

                                                          • name: string

                                                            the name of the CSS attribute to set (e.g. padding-left).

                                                          • value: string

                                                            the value of the CSS attribute to set (e.g. 12px).

                                                          Returns default

                                                          self for chaining.

                                                          -

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Constructors
                                                        Properties
                                                        Accessors
                                                        Methods
                                                        +

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Constructors
                                                        Properties
                                                        Accessors
                                                        Methods
                                                        diff --git a/docs/backend_api/enums/Backend_Script_API._internal_.HttpStatusCode.html b/docs/Script API/enums/Backend_Script_API._internal_.HttpStatusCode.html similarity index 100% rename from docs/backend_api/enums/Backend_Script_API._internal_.HttpStatusCode.html rename to docs/Script API/enums/Backend_Script_API._internal_.HttpStatusCode.html diff --git a/docs/backend_api/enums/Frontend_Script_API._internal_.FancytreeClickFolderMode.html b/docs/Script API/enums/Frontend_Script_API._internal_.FancytreeClickFolderMode.html similarity index 96% rename from docs/backend_api/enums/Frontend_Script_API._internal_.FancytreeClickFolderMode.html rename to docs/Script API/enums/Frontend_Script_API._internal_.FancytreeClickFolderMode.html index a57ca2482..9b895e362 100644 --- a/docs/backend_api/enums/Frontend_Script_API._internal_.FancytreeClickFolderMode.html +++ b/docs/Script API/enums/Frontend_Script_API._internal_.FancytreeClickFolderMode.html @@ -1,5 +1,5 @@ -FancytreeClickFolderMode | trilium
                                                        trilium
                                                          Preparing search index...

                                                          Enumeration FancytreeClickFolderMode

                                                          Index

                                                          Enumeration Members

                                                          activate +FancytreeClickFolderMode | trilium
                                                          trilium
                                                            Preparing search index...

                                                            Enumeration FancytreeClickFolderMode

                                                            Index

                                                            Enumeration Members

                                                            activate activate_and_expand activate_dblclick_expands expand -

                                                            Enumeration Members

                                                            activate: 1
                                                            activate_and_expand: 3
                                                            activate_dblclick_expands: 4
                                                            expand: 2

                                                            Settings

                                                            Member Visibility

                                                            On This Page

                                                            Enumeration Members
                                                            +

                                                            Enumeration Members

                                                            activate: 1
                                                            activate_and_expand: 3
                                                            activate_dblclick_expands: 4
                                                            expand: 2

                                                            Settings

                                                            Member Visibility

                                                            On This Page

                                                            Enumeration Members
                                                            diff --git a/docs/backend_api/enums/Frontend_Script_API._internal_.FancytreeSelectMode.html b/docs/Script API/enums/Frontend_Script_API._internal_.FancytreeSelectMode.html similarity index 96% rename from docs/backend_api/enums/Frontend_Script_API._internal_.FancytreeSelectMode.html rename to docs/Script API/enums/Frontend_Script_API._internal_.FancytreeSelectMode.html index fbbd56641..6038d6334 100644 --- a/docs/backend_api/enums/Frontend_Script_API._internal_.FancytreeSelectMode.html +++ b/docs/Script API/enums/Frontend_Script_API._internal_.FancytreeSelectMode.html @@ -1,4 +1,4 @@ -FancytreeSelectMode | trilium
                                                            trilium
                                                              Preparing search index...

                                                              Enumeration FancytreeSelectMode

                                                              Index

                                                              Enumeration Members

                                                              multi +FancytreeSelectMode | trilium
                                                              trilium
                                                                Preparing search index...

                                                                Enumeration FancytreeSelectMode

                                                                Index

                                                                Enumeration Members

                                                                multi mutlti_hier single -

                                                                Enumeration Members

                                                                multi: 2
                                                                mutlti_hier: 3
                                                                single: 1

                                                                Settings

                                                                Member Visibility

                                                                On This Page

                                                                Enumeration Members
                                                                +

                                                                Enumeration Members

                                                                multi: 2
                                                                mutlti_hier: 3
                                                                single: 1

                                                                Settings

                                                                Member Visibility

                                                                On This Page

                                                                Enumeration Members
                                                                diff --git a/docs/backend_api/functions/Backend_Script_API._internal_.node_modules__types_xml2js.parseString.html b/docs/Script API/functions/Backend_Script_API._internal_.node_modules__types_xml2js.parseString.html similarity index 100% rename from docs/backend_api/functions/Backend_Script_API._internal_.node_modules__types_xml2js.parseString.html rename to docs/Script API/functions/Backend_Script_API._internal_.node_modules__types_xml2js.parseString.html diff --git a/docs/backend_api/functions/Backend_Script_API._internal_.node_modules__types_xml2js.parseStringPromise.html b/docs/Script API/functions/Backend_Script_API._internal_.node_modules__types_xml2js.parseStringPromise.html similarity index 100% rename from docs/backend_api/functions/Backend_Script_API._internal_.node_modules__types_xml2js.parseStringPromise.html rename to docs/Script API/functions/Backend_Script_API._internal_.node_modules__types_xml2js.parseStringPromise.html diff --git a/docs/backend_api/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.firstCharLowerCase.html b/docs/Script API/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.firstCharLowerCase.html similarity index 100% rename from docs/backend_api/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.firstCharLowerCase.html rename to docs/Script API/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.firstCharLowerCase.html diff --git a/docs/backend_api/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.normalize.html b/docs/Script API/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.normalize.html similarity index 100% rename from docs/backend_api/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.normalize.html rename to docs/Script API/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.normalize.html diff --git a/docs/backend_api/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.parseBooleans.html b/docs/Script API/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.parseBooleans.html similarity index 100% rename from docs/backend_api/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.parseBooleans.html rename to docs/Script API/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.parseBooleans.html diff --git a/docs/backend_api/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.parseNumbers.html b/docs/Script API/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.parseNumbers.html similarity index 100% rename from docs/backend_api/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.parseNumbers.html rename to docs/Script API/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.parseNumbers.html diff --git a/docs/backend_api/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.stripPrefix.html b/docs/Script API/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.stripPrefix.html similarity index 100% rename from docs/backend_api/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.stripPrefix.html rename to docs/Script API/functions/Backend_Script_API._internal_.node_modules__types_xml2js.processors.stripPrefix.html diff --git a/docs/backend_api/hierarchy.html b/docs/Script API/hierarchy.html similarity index 100% rename from docs/backend_api/hierarchy.html rename to docs/Script API/hierarchy.html diff --git a/docs/backend_api/index.html b/docs/Script API/index.html similarity index 100% rename from docs/backend_api/index.html rename to docs/Script API/index.html diff --git a/docs/backend_api/interfaces/Backend_Script_API.Api.html b/docs/Script API/interfaces/Backend_Script_API.Api.html similarity index 97% rename from docs/backend_api/interfaces/Backend_Script_API.Api.html rename to docs/Script API/interfaces/Backend_Script_API.Api.html index 8a22dcfb4..117857c61 100644 --- a/docs/backend_api/interfaces/Backend_Script_API.Api.html +++ b/docs/Script API/interfaces/Backend_Script_API.Api.html @@ -1,4 +1,4 @@ -Api | trilium
                                                                trilium
                                                                  Preparing search index...

                                                                  Interface Api

                                                                  interface Api {
                                                                      __private: { becca: default };
                                                                      axios: AxiosStatic;
                                                                      cheerio: {
                                                                          default: CheerioAPI;
                                                                          version: string;
                                                                          contains(container: Element, contained: Element): boolean;
                                                                          html(options?: CheerioParserOptions): string;
                                                                          html(
                                                                              dom: string | Element | Cheerio,
                                                                              options?: CheerioParserOptions,
                                                                          ): string;
                                                                          load(
                                                                              html: string | Buffer<ArrayBufferLike>,
                                                                              options?: CheerioParserOptions,
                                                                          ): Root;
                                                                          load(element: Element | Element[], options?: CheerioParserOptions): Root;
                                                                          parseHTML(
                                                                              data: string,
                                                                              context?: null | Document,
                                                                              keepScripts?: boolean,
                                                                          ): Document[];
                                                                          root(): Cheerio;
                                                                          xml(dom?: string | Element | Cheerio): string;
                                                                      };
                                                                      currentNote: BNote;
                                                                      dayjs: __module;
                                                                      logMessages: Record<string, string[]>;
                                                                      logSpacedUpdates: Record<string, SpacedUpdate>;
                                                                      originEntity?: null | AbstractBeccaEntity<any>;
                                                                      sql: any;
                                                                      startNote?: null | BNote;
                                                                      xml2js: node_modules/@types/xml2js;
                                                                      backupNow(backupName: string): Promise<string>;
                                                                      createDataNote(
                                                                          parentNoteId: string,
                                                                          title: string,
                                                                          content: {},
                                                                      ): NoteAndBranch;
                                                                      createNewNote(params: NoteParams): NoteAndBranch;
                                                                      createNote(
                                                                          parentNoteId: string,
                                                                          title: string,
                                                                          content: string,
                                                                          extraOptions: Omit<
                                                                              NoteParams,
                                                                              "title"
                                                                              | "parentNoteId"
                                                                              | "content"
                                                                              | "type",
                                                                          > & { attributes?: AttributeRow[]; json?: boolean },
                                                                      ): NoteAndBranch;
                                                                      createOrUpdateLauncher(
                                                                          opts: {
                                                                              icon: string;
                                                                              id: string;
                                                                              isVisible: boolean;
                                                                              keyboardShortcut: string;
                                                                              scriptNoteId: string;
                                                                              targetNoteId: string;
                                                                              title: string;
                                                                              type: "script" | "note" | "customWidget";
                                                                              widgetNoteId?: string;
                                                                          },
                                                                      ): { note: BNote };
                                                                      createTextNote(
                                                                          parentNoteId: string,
                                                                          title: string,
                                                                          content: string,
                                                                      ): NoteAndBranch;
                                                                      ensureNoteIsAbsentFromParent(noteId: string, parentNoteId: string): void;
                                                                      ensureNoteIsPresentInParent(
                                                                          noteId: string,
                                                                          parentNoteId: string,
                                                                          prefix: string,
                                                                      ): { branch: null | BBranch };
                                                                      escapeHtml(string: string): string;
                                                                      exportSubtreeToZipFile(
                                                                          noteId: string,
                                                                          format: "html" | "markdown",
                                                                          zipFilePath: string,
                                                                      ): Promise<void>;
                                                                      getAppInfo(): {
                                                                          appVersion: string;
                                                                          buildDate: string;
                                                                          buildRevision: string;
                                                                          clipperProtocolVersion: string;
                                                                          dataDirectory: string;
                                                                          dbVersion: number;
                                                                          nodeVersion: string;
                                                                          syncVersion: number;
                                                                          utcDateTime: string;
                                                                      };
                                                                      getAttachment(attachmentId: string): null | BAttachment;
                                                                      getAttribute(attachmentId: string): null | BAttribute;
                                                                      getAttribute(attributeId: string): null | BAttribute;
                                                                      getBranch(branchId: string): null | BBranch;
                                                                      getDayNote(date: string, rootNote?: BNote): Promise<null | BNote>;
                                                                      getEtapiToken(etapiTokenId: string): null | BEtapiToken;
                                                                      getEtapiTokens(): BEtapiToken[];
                                                                      getInstanceName(): null | string;
                                                                      getMonthNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                      getNote(noteId: string): null | BNote;
                                                                      getNotesWithLabel(name: string, value?: string): BNote[];
                                                                      getNoteWithLabel(name: string, value?: string): null | BNote;
                                                                      getOption(optionName: string): null | BOption;
                                                                      getOptions(): BOption[];
                                                                      getQuarterNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                      getRevision(revisionId: string): null | BRevision;
                                                                      getRootCalendarNote(): null | BNote;
                                                                      getTodayNote(rootNote?: BNote): Promise<null | BNote>;
                                                                      getWeekFirstDayNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                      getWeekNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                      getYearNote(year: string, rootNote?: BNote): null | BNote;
                                                                      log(message: string): void;
                                                                      randomString(length: number): string;
                                                                      runOnFrontend(script: () => string | void, params: []): void;
                                                                      runOutsideOfSync(callback: () => void): Promise<void>;
                                                                      searchForNote(query: string, searchParams: SearchParams): null | BNote;
                                                                      searchForNotes(query: string, searchParams: SearchParams): BNote[];
                                                                      setNoteToParent(
                                                                          noteId: string,
                                                                          prefix: string,
                                                                          parentNoteId: null | string,
                                                                      ): void;
                                                                      sortNotes(
                                                                          parentNoteId: string,
                                                                          sortConfig: { foldersFirst?: boolean; reverse?: boolean; sortBy?: string },
                                                                      ): void;
                                                                      toggleNoteInParent(
                                                                          present: true,
                                                                          noteId: string,
                                                                          parentNoteId: string,
                                                                          prefix: string,
                                                                      ): void;
                                                                      transactional(func: () => void): any;
                                                                      unescapeHtml(string: string): string;
                                                                  }
                                                                  Index

                                                                  Properties

                                                                  __private +Api | trilium
                                                                  trilium
                                                                    Preparing search index...

                                                                    Interface Api

                                                                    interface Api {
                                                                        __private: { becca: default };
                                                                        axios: AxiosStatic;
                                                                        cheerio: {
                                                                            default: CheerioAPI;
                                                                            version: string;
                                                                            contains(container: Element, contained: Element): boolean;
                                                                            html(options?: CheerioParserOptions): string;
                                                                            html(
                                                                                dom: string | Element | Cheerio,
                                                                                options?: CheerioParserOptions,
                                                                            ): string;
                                                                            load(
                                                                                html: string | Buffer<ArrayBufferLike>,
                                                                                options?: CheerioParserOptions,
                                                                            ): Root;
                                                                            load(element: Element | Element[], options?: CheerioParserOptions): Root;
                                                                            parseHTML(
                                                                                data: string,
                                                                                context?: null | Document,
                                                                                keepScripts?: boolean,
                                                                            ): Document[];
                                                                            root(): Cheerio;
                                                                            xml(dom?: string | Element | Cheerio): string;
                                                                        };
                                                                        currentNote: BNote;
                                                                        dayjs: __module;
                                                                        logMessages: Record<string, string[]>;
                                                                        logSpacedUpdates: Record<string, SpacedUpdate>;
                                                                        originEntity?: null | AbstractBeccaEntity<any>;
                                                                        sql: any;
                                                                        startNote?: null | BNote;
                                                                        xml2js: node_modules/@types/xml2js;
                                                                        backupNow(backupName: string): Promise<string>;
                                                                        createDataNote(
                                                                            parentNoteId: string,
                                                                            title: string,
                                                                            content: {},
                                                                        ): NoteAndBranch;
                                                                        createNewNote(params: NoteParams): NoteAndBranch;
                                                                        createNote(
                                                                            parentNoteId: string,
                                                                            title: string,
                                                                            content: string,
                                                                            extraOptions: Omit<
                                                                                NoteParams,
                                                                                "title"
                                                                                | "parentNoteId"
                                                                                | "content"
                                                                                | "type",
                                                                            > & { attributes?: AttributeRow[]; json?: boolean },
                                                                        ): NoteAndBranch;
                                                                        createOrUpdateLauncher(
                                                                            opts: {
                                                                                icon: string;
                                                                                id: string;
                                                                                isVisible: boolean;
                                                                                keyboardShortcut: string;
                                                                                scriptNoteId: string;
                                                                                targetNoteId: string;
                                                                                title: string;
                                                                                type: "script" | "note" | "customWidget";
                                                                                widgetNoteId?: string;
                                                                            },
                                                                        ): { note: BNote };
                                                                        createTextNote(
                                                                            parentNoteId: string,
                                                                            title: string,
                                                                            content: string,
                                                                        ): NoteAndBranch;
                                                                        ensureNoteIsAbsentFromParent(noteId: string, parentNoteId: string): void;
                                                                        ensureNoteIsPresentInParent(
                                                                            noteId: string,
                                                                            parentNoteId: string,
                                                                            prefix: string,
                                                                        ): { branch: null | BBranch };
                                                                        escapeHtml(string: string): string;
                                                                        exportSubtreeToZipFile(
                                                                            noteId: string,
                                                                            format: "html" | "markdown",
                                                                            zipFilePath: string,
                                                                        ): Promise<void>;
                                                                        getAppInfo(): {
                                                                            appVersion: string;
                                                                            buildDate: string;
                                                                            buildRevision: string;
                                                                            clipperProtocolVersion: string;
                                                                            dataDirectory: string;
                                                                            dbVersion: number;
                                                                            nodeVersion: string;
                                                                            syncVersion: number;
                                                                            utcDateTime: string;
                                                                        };
                                                                        getAttachment(attachmentId: string): null | BAttachment;
                                                                        getAttribute(attachmentId: string): null | BAttribute;
                                                                        getAttribute(attributeId: string): null | BAttribute;
                                                                        getBranch(branchId: string): null | BBranch;
                                                                        getDayNote(date: string, rootNote?: BNote): Promise<null | BNote>;
                                                                        getEtapiToken(etapiTokenId: string): null | BEtapiToken;
                                                                        getEtapiTokens(): BEtapiToken[];
                                                                        getInstanceName(): null | string;
                                                                        getMonthNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                        getNote(noteId: string): null | BNote;
                                                                        getNotesWithLabel(name: string, value?: string): BNote[];
                                                                        getNoteWithLabel(name: string, value?: string): null | BNote;
                                                                        getOption(optionName: string): null | BOption;
                                                                        getOptions(): BOption[];
                                                                        getQuarterNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                        getRevision(revisionId: string): null | BRevision;
                                                                        getRootCalendarNote(): null | BNote;
                                                                        getTodayNote(rootNote?: BNote): Promise<null | BNote>;
                                                                        getWeekFirstDayNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                        getWeekNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                        getYearNote(year: string, rootNote?: BNote): null | BNote;
                                                                        log(message: string): void;
                                                                        randomString(length: number): string;
                                                                        runOnFrontend(script: () => string | void, params: []): void;
                                                                        runOutsideOfSync(callback: () => void): Promise<void>;
                                                                        searchForNote(query: string, searchParams: SearchParams): null | BNote;
                                                                        searchForNotes(query: string, searchParams: SearchParams): BNote[];
                                                                        setNoteToParent(
                                                                            noteId: string,
                                                                            prefix: string,
                                                                            parentNoteId: null | string,
                                                                        ): void;
                                                                        sortNotes(
                                                                            parentNoteId: string,
                                                                            sortConfig: { foldersFirst?: boolean; reverse?: boolean; sortBy?: string },
                                                                        ): void;
                                                                        toggleNoteInParent(
                                                                            present: true,
                                                                            noteId: string,
                                                                            parentNoteId: string,
                                                                            prefix: string,
                                                                        ): void;
                                                                        transactional(func: () => void): any;
                                                                        unescapeHtml(string: string): string;
                                                                    }
                                                                    Index

                                                                    Properties

                                                                    __private axios cheerio currentNote @@ -53,29 +53,29 @@ unescapeHtml

                                                                    Properties

                                                                    __private

                                                                    __private: { becca: default }

                                                                    This object contains "at your risk" and "no BC guarantees" objects for advanced use cases.

                                                                    Type declaration

                                                                    • becca: default

                                                                      provides access to the backend in-memory object graph, see Becca

                                                                      -
                                                                    axios: AxiosStatic

                                                                    Axios library for HTTP requests. See https://axios-http.com for documentation

                                                                    +
                                                                    axios: AxiosStatic

                                                                    Axios library for HTTP requests. See https://axios-http.com for documentation

                                                                    use native (browser compatible) fetch() instead

                                                                    -
                                                                    cheerio: {
                                                                        default: CheerioAPI;
                                                                        version: string;
                                                                        contains(container: Element, contained: Element): boolean;
                                                                        html(options?: CheerioParserOptions): string;
                                                                        html(
                                                                            dom: string | Element | Cheerio,
                                                                            options?: CheerioParserOptions,
                                                                        ): string;
                                                                        load(
                                                                            html: string | Buffer<ArrayBufferLike>,
                                                                            options?: CheerioParserOptions,
                                                                        ): Root;
                                                                        load(element: Element | Element[], options?: CheerioParserOptions): Root;
                                                                        parseHTML(
                                                                            data: string,
                                                                            context?: null | Document,
                                                                            keepScripts?: boolean,
                                                                        ): Document[];
                                                                        root(): Cheerio;
                                                                        xml(dom?: string | Element | Cheerio): string;
                                                                    }

                                                                    cheerio library for HTML parsing and manipulation. See https://cheerio.js.org for documentation

                                                                    -
                                                                    currentNote: BNote

                                                                    Note where the script is currently executing. This comes into play when your script is spread in multiple code +

                                                                    cheerio: {
                                                                        default: CheerioAPI;
                                                                        version: string;
                                                                        contains(container: Element, contained: Element): boolean;
                                                                        html(options?: CheerioParserOptions): string;
                                                                        html(
                                                                            dom: string | Element | Cheerio,
                                                                            options?: CheerioParserOptions,
                                                                        ): string;
                                                                        load(
                                                                            html: string | Buffer<ArrayBufferLike>,
                                                                            options?: CheerioParserOptions,
                                                                        ): Root;
                                                                        load(element: Element | Element[], options?: CheerioParserOptions): Root;
                                                                        parseHTML(
                                                                            data: string,
                                                                            context?: null | Document,
                                                                            keepScripts?: boolean,
                                                                        ): Document[];
                                                                        root(): Cheerio;
                                                                        xml(dom?: string | Element | Cheerio): string;
                                                                    }

                                                                    cheerio library for HTML parsing and manipulation. See https://cheerio.js.org for documentation

                                                                    +
                                                                    currentNote: BNote

                                                                    Note where the script is currently executing. This comes into play when your script is spread in multiple code notes, the script starts in "startNote", but then through function calls may jump into another note (currentNote). A similar concept in C would be FILE Don't mix this up with the concept of active note.

                                                                    -
                                                                    dayjs: __module

                                                                    day.js library for date manipulation. See https://day.js.org for documentation

                                                                    -
                                                                    logMessages: Record<string, string[]>
                                                                    logSpacedUpdates: Record<string, SpacedUpdate>
                                                                    originEntity?: null | AbstractBeccaEntity<any>

                                                                    Entity whose event triggered this execution

                                                                    -
                                                                    sql: any

                                                                    sql

                                                                    -
                                                                    startNote?: null | BNote

                                                                    Note where the script started executing (entrypoint). +

                                                                    dayjs: __module

                                                                    day.js library for date manipulation. See https://day.js.org for documentation

                                                                    +
                                                                    logMessages: Record<string, string[]>
                                                                    logSpacedUpdates: Record<string, SpacedUpdate>
                                                                    originEntity?: null | AbstractBeccaEntity<any>

                                                                    Entity whose event triggered this execution

                                                                    +
                                                                    sql: any

                                                                    sql

                                                                    +
                                                                    startNote?: null | BNote

                                                                    Note where the script started executing (entrypoint). As an analogy, in C this would be the file which contains the main() function of the current process.

                                                                    -
                                                                    xml2js: node_modules/@types/xml2js

                                                                    xml2js library for XML parsing. See https://github.com/Leonidas-from-XIV/node-xml2js for documentation

                                                                    -

                                                                    Methods

                                                                    • Parameters

                                                                    xml2js: node_modules/@types/xml2js

                                                                    xml2js library for XML parsing. See https://github.com/Leonidas-from-XIV/node-xml2js for documentation

                                                                    +

                                                                    Methods

                                                                    • Parameters

                                                                      • backupName: string

                                                                        If the backupName is e.g. "now", then the backup will be written to "backup-now.db" file

                                                                      Returns Promise<string>

                                                                      resolves once the backup is finished

                                                                      -

                                                                    • Create data note - data in this context means object serializable to JSON. Created note will be of type 'code' and JSON MIME type. See also createNewNote() for more options.

                                                                      -

                                                                      Parameters

                                                                      • parentNoteId: string
                                                                      • title: string
                                                                      • content: {}

                                                                      Returns NoteAndBranch

                                                                    • Parameters

                                                                    • Parameters

                                                                      • parentNoteId: string

                                                                        create new note under this parent

                                                                      • title: string
                                                                      • content: string
                                                                      • extraOptions: Omit<NoteParams, "title" | "parentNoteId" | "content" | "type"> & {
                                                                            attributes?: AttributeRow[];
                                                                            json?: boolean;
                                                                        }
                                                                        • Optionalattributes?: AttributeRow[]
                                                                        • Optionaljson?: boolean

                                                                          should the note be JSON

                                                                      Returns NoteAndBranch

                                                                      object contains newly created entities note and branch

                                                                      please use createTextNote() with similar API for simpler use cases or createNewNote() for more complex needs

                                                                      -

                                                                    • Creates a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.

                                                                      +

                                                                    • Creates a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.

                                                                      Parameters

                                                                      • opts: {
                                                                            icon: string;
                                                                            id: string;
                                                                            isVisible: boolean;
                                                                            keyboardShortcut: string;
                                                                            scriptNoteId: string;
                                                                            targetNoteId: string;
                                                                            title: string;
                                                                            type: "script" | "note" | "customWidget";
                                                                            widgetNoteId?: string;
                                                                        }
                                                                        • icon: string

                                                                          name of the boxicon to be used (e.g. "bx-time")

                                                                        • id: string

                                                                          id of the launcher, only alphanumeric at least 6 characters long

                                                                        • isVisible: boolean

                                                                          if true, will be created in the "Visible launchers", otherwise in "Available launchers"

                                                                          @@ -89,76 +89,76 @@ JSON MIME type. See also createNewNote() for more options.

                                                                        • "customWidget" - the launcher will be rendered with a custom widget (specified in widgetNoteId param)
                                                                    • OptionalwidgetNoteId?: string

                                                                      for type "customWidget"

                                                                      -

                                                                    Returns { note: BNote }

                                                                    • If there's a branch between note and parent note, remove it. Otherwise, do nothing.

                                                                      -

                                                                      Parameters

                                                                      • noteId: string
                                                                      • parentNoteId: string

                                                                      Returns void

                                                                    • If there's no branch between note and parent note, create one. Otherwise, do nothing. Returns the new or existing branch.

                                                                      +

                                                                    Returns { note: BNote }

                                                                    • If there's a branch between note and parent note, remove it. Otherwise, do nothing.

                                                                      +

                                                                      Parameters

                                                                      • noteId: string
                                                                      • parentNoteId: string

                                                                      Returns void

                                                                    • If there's no branch between note and parent note, create one. Otherwise, do nothing. Returns the new or existing branch.

                                                                      Parameters

                                                                      • noteId: string
                                                                      • parentNoteId: string
                                                                      • prefix: string

                                                                        if branch is created between note and parent note, set this prefix

                                                                        -

                                                                      Returns { branch: null | BBranch }

                                                                    • Parameters

                                                                      • noteId: string
                                                                      • format: "html" | "markdown"

                                                                        either 'html' or 'markdown'

                                                                        -
                                                                      • zipFilePath: string

                                                                      Returns Promise<void>

                                                                    • Returns {
                                                                          appVersion: string;
                                                                          buildDate: string;
                                                                          buildRevision: string;
                                                                          clipperProtocolVersion: string;
                                                                          dataDirectory: string;
                                                                          dbVersion: number;
                                                                          nodeVersion: string;
                                                                          syncVersion: number;
                                                                          utcDateTime: string;
                                                                      }

                                                                    • Returns day note for given date. If such note doesn't exist, it is created.

                                                                      +

                                                                    Returns { branch: null | BBranch }

                                                                    • Parameters

                                                                      • noteId: string
                                                                      • format: "html" | "markdown"

                                                                        either 'html' or 'markdown'

                                                                        +
                                                                      • zipFilePath: string

                                                                      Returns Promise<void>

                                                                    • Returns {
                                                                          appVersion: string;
                                                                          buildDate: string;
                                                                          buildRevision: string;
                                                                          clipperProtocolVersion: string;
                                                                          dataDirectory: string;
                                                                          dbVersion: number;
                                                                          nodeVersion: string;
                                                                          syncVersion: number;
                                                                          utcDateTime: string;
                                                                      }

                                                                    • Returns day note for given date. If such note doesn't exist, it is created.

                                                                      Parameters

                                                                      • date: string

                                                                        in YYYY-MM-DD format

                                                                      • OptionalrootNote: BNote

                                                                        specify calendar root note, normally leave empty to use the default calendar

                                                                        -

                                                                      Returns Promise<null | BNote>

                                                                    • Instance name identifies particular Trilium instance. It can be useful for scripts +

                                                                    Returns Promise<null | BNote>

                                                                    • Instance name identifies particular Trilium instance. It can be useful for scripts if some action needs to happen on only one specific instance.

                                                                      -

                                                                      Returns null | string

                                                                    • Returns month note for given date. If such a note doesn't exist, it is created.

                                                                      Parameters

                                                                      • date: string

                                                                        in YYYY-MM format

                                                                      • rootNote: BNote

                                                                        specify calendar root note, normally leave empty to use the default calendar

                                                                        -

                                                                      Returns Promise<null | BNote>

                                                                    • Retrieves notes with given label name & value

                                                                      +

                                                                    Returns Promise<null | BNote>

                                                                    • Retrieves notes with given label name & value

                                                                      Parameters

                                                                      • name: string

                                                                        attribute name

                                                                      • Optionalvalue: string

                                                                        attribute value

                                                                        -

                                                                      Returns BNote[]

                                                                    • Retrieves first note with given label name & value

                                                                      +

                                                                    Returns BNote[]

                                                                    • Retrieves first note with given label name & value

                                                                      Parameters

                                                                      • name: string

                                                                        attribute name

                                                                      • Optionalvalue: string

                                                                        attribute value

                                                                        -

                                                                      Returns null | BNote

                                                                    • Returns quarter note for given date. If such a note doesn't exist, it is created.

                                                                      +

                                                                    Returns null | BNote

                                                                    • Returns quarter note for given date. If such a note doesn't exist, it is created.

                                                                      Parameters

                                                                      • date: string

                                                                        in YYYY-MM format

                                                                      • rootNote: BNote

                                                                        specify calendar root note, normally leave empty to use the default calendar

                                                                        -

                                                                      Returns Promise<null | BNote>

                                                                    • Returns today's day note. If such note doesn't exist, it is created.

                                                                      +

                                                                    Returns Promise<null | BNote>

                                                                    • Returns today's day note. If such note doesn't exist, it is created.

                                                                      Parameters

                                                                      • OptionalrootNote: BNote

                                                                        specify calendar root note, normally leave empty to use the default calendar

                                                                        -

                                                                      Returns Promise<null | BNote>

                                                                    • Returns note for the first date of the week of the given date.

                                                                      +

                                                                    Returns Promise<null | BNote>

                                                                    • Returns note for the first date of the week of the given date.

                                                                      Parameters

                                                                      • date: string

                                                                        in YYYY-MM-DD format

                                                                      • rootNote: BNote

                                                                        specify calendar root note, normally leave empty to use the default calendar

                                                                        -

                                                                      Returns Promise<null | BNote>

                                                                    • Returns week note for given date. If such a note doesn't exist, it is created.

                                                                      +

                                                                    Returns Promise<null | BNote>

                                                                    • Returns week note for given date. If such a note doesn't exist, it is created.

                                                                      Parameters

                                                                      • date: string

                                                                        in YYYY-MM-DD format

                                                                      • rootNote: BNote

                                                                        specify calendar root note, normally leave empty to use the default calendar

                                                                        -

                                                                      Returns Promise<null | BNote>

                                                                    • Returns year note for given year. If such a note doesn't exist, it is created.

                                                                      +

                                                                    Returns Promise<null | BNote>

                                                                    • Returns year note for given year. If such a note doesn't exist, it is created.

                                                                      Parameters

                                                                      • year: string

                                                                        in YYYY format

                                                                      • OptionalrootNote: BNote

                                                                        specify calendar root note, normally leave empty to use the default calendar

                                                                        -

                                                                      Returns null | BNote

                                                                    • Return randomly generated string of given length. This random string generation is NOT cryptographically secure.

                                                                      +

                                                                    Returns null | BNote

                                                                    • Return randomly generated string of given length. This random string generation is NOT cryptographically secure.

                                                                      Parameters

                                                                      • length: number

                                                                        of the string

                                                                      Returns string

                                                                      random string

                                                                      -

                                                                    • Executes given anonymous function on the frontend(s). Internally, this serializes the anonymous function into string and sends it to frontend(s) via WebSocket. Note that there can be multiple connected frontend instances (e.g. in different tabs). In such case, all instances execute the given function.

                                                                      Parameters

                                                                      • script: () => string | void

                                                                        script to be executed on the frontend

                                                                      • params: []

                                                                        list of parameters to the anonymous function to be sent to frontend

                                                                      Returns void

                                                                      no return value is provided.

                                                                      -

                                                                    • Sync process can make data intermittently inconsistent. Scripts which require strong data consistency +

                                                                    • Sync process can make data intermittently inconsistent. Scripts which require strong data consistency can use this function to wait for a possible sync process to finish and prevent new sync process from starting while it is running.

                                                                      Because this is an async process, the inner callback doesn't have automatic transaction handling, so in case you need to make some DB changes, you need to surround your call with api.transactional(...)

                                                                      Parameters

                                                                      • callback: () => void

                                                                        function to be executed while sync process is not running

                                                                      Returns Promise<void>

                                                                      resolves once the callback is finished (callback is awaited)

                                                                      -

                                                                    • This method finds note by its noteId and prefix and either sets it to the given parentNoteId +

                                                                      Parameters

                                                                      Returns BNote[]

                                                                    • This method finds note by its noteId and prefix and either sets it to the given parentNoteId or removes the branch (if parentNoteId is not given).

                                                                      This method looks similar to toggleNoteInParent() but differs because we're looking up branch by prefix.

                                                                      Parameters

                                                                      • noteId: string
                                                                      • prefix: string
                                                                      • parentNoteId: null | string

                                                                      Returns void

                                                                      this method is pretty confusing and serves specialized purpose only

                                                                      -

                                                                    • Sort child notes of a given note.

                                                                      +

                                                                    • Sort child notes of a given note.

                                                                      Parameters

                                                                      • parentNoteId: string
                                                                      • sortConfig: { foldersFirst?: boolean; reverse?: boolean; sortBy?: string }

                                                                      Returns void

                                                                    • Based on the value, either create or remove branch between note and parent note.

                                                                      +

                                                                    Returns void

                                                                    • Based on the value, either create or remove branch between note and parent note.

                                                                      Parameters

                                                                      • present: true

                                                                        true if we want the branch to exist, false if we want it gone

                                                                      • noteId: string
                                                                      • parentNoteId: string
                                                                      • prefix: string

                                                                        if branch is created between note and parent note, set this prefix

                                                                        -

                                                                      Returns void

                                                                    • This functions wraps code which is supposed to be running in transaction. If transaction already +

                                                                    Returns void

                                                                    • This functions wraps code which is supposed to be running in transaction. If transaction already exists, then we'll use that transaction.

                                                                      Parameters

                                                                      • func: () => void

                                                                      Returns any

                                                                      result of func callback

                                                                      -

                                                                    Settings

                                                                    Member Visibility

                                                                    On This Page

                                                                    Properties
                                                                    Methods
                                                                    +

                                                                    Settings

                                                                    Member Visibility

                                                                    On This Page

                                                                    Properties
                                                                    Methods
                                                                    diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AsyncResourceOptions.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AsyncResourceOptions.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AsyncResourceOptions.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AsyncResourceOptions.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AttachmentOpts.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AttachmentOpts.html similarity index 97% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AttachmentOpts.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AttachmentOpts.html index dddb266bd..dd3f2c7e7 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.AttachmentOpts.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.AttachmentOpts.html @@ -1,2 +1,2 @@ -AttachmentOpts | trilium
                                                                    trilium
                                                                      Preparing search index...

                                                                      Interface AttachmentOpts

                                                                      interface AttachmentOpts {
                                                                          includeContentLength?: boolean;
                                                                      }
                                                                      Index

                                                                      Properties

                                                                      includeContentLength? -

                                                                      Properties

                                                                      includeContentLength?: boolean

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Properties
                                                                      +AttachmentOpts | trilium
                                                                      trilium
                                                                        Preparing search index...

                                                                        Interface AttachmentOpts

                                                                        interface AttachmentOpts {
                                                                            includeContentLength?: boolean;
                                                                        }
                                                                        Index

                                                                        Properties

                                                                        includeContentLength? +

                                                                        Properties

                                                                        includeContentLength?: boolean

                                                                        Settings

                                                                        Member Visibility

                                                                        On This Page

                                                                        Properties
                                                                        diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AttachmentRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AttachmentRow.html similarity index 94% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AttachmentRow.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AttachmentRow.html index 87b2f0327..9abd3cea0 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.AttachmentRow.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.AttachmentRow.html @@ -1,4 +1,4 @@ -AttachmentRow | trilium
                                                                        trilium
                                                                          Preparing search index...

                                                                          Interface AttachmentRow

                                                                          interface AttachmentRow {
                                                                              attachmentId?: string;
                                                                              blobId?: string;
                                                                              content?: string | Buffer<ArrayBufferLike>;
                                                                              contentLength?: number;
                                                                              dateModified?: string;
                                                                              deleteId?: string;
                                                                              isDeleted?: boolean;
                                                                              isProtected?: boolean;
                                                                              mime: string;
                                                                              ownerId?: string;
                                                                              position?: number;
                                                                              role: string;
                                                                              title: string;
                                                                              utcDateModified?: string;
                                                                              utcDateScheduledForErasureSince?: string;
                                                                          }
                                                                          Index

                                                                          Properties

                                                                          attachmentId? +AttachmentRow | trilium
                                                                          trilium
                                                                            Preparing search index...

                                                                            Interface AttachmentRow

                                                                            interface AttachmentRow {
                                                                                attachmentId?: string;
                                                                                blobId?: string;
                                                                                content?: string | Buffer<ArrayBufferLike>;
                                                                                contentLength?: number;
                                                                                dateModified?: string;
                                                                                deleteId?: string;
                                                                                isDeleted?: boolean;
                                                                                isProtected?: boolean;
                                                                                mime: string;
                                                                                ownerId?: string;
                                                                                position?: number;
                                                                                role: string;
                                                                                title: string;
                                                                                utcDateModified?: string;
                                                                                utcDateScheduledForErasureSince?: string;
                                                                            }
                                                                            Index

                                                                            Properties

                                                                            attachmentId? blobId? content? contentLength? @@ -13,4 +13,4 @@ title utcDateModified? utcDateScheduledForErasureSince? -

                                                                            Properties

                                                                            attachmentId?: string
                                                                            blobId?: string

                                                                            Optionalcontent

                                                                            content?: string | Buffer<ArrayBufferLike>
                                                                            contentLength?: number
                                                                            dateModified?: string
                                                                            deleteId?: string
                                                                            isDeleted?: boolean
                                                                            isProtected?: boolean
                                                                            mime: string
                                                                            ownerId?: string
                                                                            position?: number
                                                                            role: string
                                                                            title: string
                                                                            utcDateModified?: string
                                                                            utcDateScheduledForErasureSince?: string

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Properties
                                                                            +

                                                                            Properties

                                                                            attachmentId?: string
                                                                            blobId?: string

                                                                            Optionalcontent

                                                                            content?: string | Buffer<ArrayBufferLike>
                                                                            contentLength?: number
                                                                            dateModified?: string
                                                                            deleteId?: string
                                                                            isDeleted?: boolean
                                                                            isProtected?: boolean
                                                                            mime: string
                                                                            ownerId?: string
                                                                            position?: number
                                                                            role: string
                                                                            title: string
                                                                            utcDateModified?: string
                                                                            utcDateScheduledForErasureSince?: string

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Properties
                                                                            diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AttributeRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AttributeRow.html similarity index 95% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AttributeRow.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AttributeRow.html index 122a1c467..1c0a35974 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.AttributeRow.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.AttributeRow.html @@ -1,4 +1,4 @@ -AttributeRow | trilium
                                                                            trilium
                                                                              Preparing search index...

                                                                              Interface AttributeRow

                                                                              interface AttributeRow {
                                                                                  attributeId?: string;
                                                                                  isInheritable?: boolean;
                                                                                  name: string;
                                                                                  noteId?: string;
                                                                                  position?: null | number;
                                                                                  type: AttributeType;
                                                                                  utcDateModified?: string;
                                                                                  value?: string;
                                                                              }
                                                                              Index

                                                                              Properties

                                                                              attributeId? +AttributeRow | trilium
                                                                              trilium
                                                                                Preparing search index...

                                                                                Interface AttributeRow

                                                                                interface AttributeRow {
                                                                                    attributeId?: string;
                                                                                    isInheritable?: boolean;
                                                                                    name: string;
                                                                                    noteId?: string;
                                                                                    position?: null | number;
                                                                                    type: AttributeType;
                                                                                    utcDateModified?: string;
                                                                                    value?: string;
                                                                                }
                                                                                Index

                                                                                Properties

                                                                                attributeId? isInheritable? name noteId? @@ -6,4 +6,4 @@ type utcDateModified? value? -

                                                                                Properties

                                                                                attributeId?: string
                                                                                isInheritable?: boolean
                                                                                name: string
                                                                                noteId?: string
                                                                                position?: null | number
                                                                                type: AttributeType
                                                                                utcDateModified?: string
                                                                                value?: string

                                                                                Settings

                                                                                Member Visibility

                                                                                On This Page

                                                                                Properties
                                                                                +

                                                                                Properties

                                                                                attributeId?: string
                                                                                isInheritable?: boolean
                                                                                name: string
                                                                                noteId?: string
                                                                                position?: null | number
                                                                                type: AttributeType
                                                                                utcDateModified?: string
                                                                                value?: string

                                                                                Settings

                                                                                Member Visibility

                                                                                On This Page

                                                                                Properties
                                                                                diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosAdapter.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AxiosAdapter.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosAdapter.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AxiosAdapter.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosBasicCredentials.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AxiosBasicCredentials.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosBasicCredentials.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AxiosBasicCredentials.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosDefaults.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AxiosDefaults.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosDefaults.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AxiosDefaults.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosInstance.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AxiosInstance.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosInstance.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AxiosInstance.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosInterceptorManager.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AxiosInterceptorManager.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosInterceptorManager.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AxiosInterceptorManager.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosInterceptorOptions.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AxiosInterceptorOptions.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosInterceptorOptions.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AxiosInterceptorOptions.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosProgressEvent.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AxiosProgressEvent.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosProgressEvent.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AxiosProgressEvent.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosProxyConfig.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AxiosProxyConfig.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosProxyConfig.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AxiosProxyConfig.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosRequestConfig.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AxiosRequestConfig.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosRequestConfig.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AxiosRequestConfig.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosRequestTransformer.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AxiosRequestTransformer.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosRequestTransformer.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AxiosRequestTransformer.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosResponse.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AxiosResponse.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosResponse.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AxiosResponse.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosResponseTransformer.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AxiosResponseTransformer.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosResponseTransformer.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AxiosResponseTransformer.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosStatic.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AxiosStatic.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosStatic.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.AxiosStatic.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.BranchRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.BranchRow.html similarity index 95% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.BranchRow.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.BranchRow.html index 6b5373063..c75ed134f 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.BranchRow.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.BranchRow.html @@ -1,4 +1,4 @@ -BranchRow | trilium
                                                                                trilium
                                                                                  Preparing search index...

                                                                                  Interface BranchRow

                                                                                  interface BranchRow {
                                                                                      branchId?: string;
                                                                                      isDeleted?: boolean;
                                                                                      isExpanded?: boolean;
                                                                                      noteId: string;
                                                                                      notePosition?: null | number;
                                                                                      parentNoteId: string;
                                                                                      prefix?: null | string;
                                                                                      utcDateModified?: string;
                                                                                  }
                                                                                  Index

                                                                                  Properties

                                                                                  branchId? +BranchRow | trilium
                                                                                  trilium
                                                                                    Preparing search index...

                                                                                    Interface BranchRow

                                                                                    interface BranchRow {
                                                                                        branchId?: string;
                                                                                        isDeleted?: boolean;
                                                                                        isExpanded?: boolean;
                                                                                        noteId: string;
                                                                                        notePosition?: null | number;
                                                                                        parentNoteId: string;
                                                                                        prefix?: null | string;
                                                                                        utcDateModified?: string;
                                                                                    }
                                                                                    Index

                                                                                    Properties

                                                                                    branchId? isDeleted? isExpanded? noteId @@ -6,4 +6,4 @@ parentNoteId prefix? utcDateModified? -

                                                                                    Properties

                                                                                    branchId?: string
                                                                                    isDeleted?: boolean
                                                                                    isExpanded?: boolean
                                                                                    noteId: string
                                                                                    notePosition?: null | number
                                                                                    parentNoteId: string
                                                                                    prefix?: null | string
                                                                                    utcDateModified?: string

                                                                                    Settings

                                                                                    Member Visibility

                                                                                    On This Page

                                                                                    Properties
                                                                                    +

                                                                                    Properties

                                                                                    branchId?: string
                                                                                    isDeleted?: boolean
                                                                                    isExpanded?: boolean
                                                                                    noteId: string
                                                                                    notePosition?: null | number
                                                                                    parentNoteId: string
                                                                                    prefix?: null | string
                                                                                    utcDateModified?: string

                                                                                    Settings

                                                                                    Member Visibility

                                                                                    On This Page

                                                                                    Properties
                                                                                    diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.CallSite.html b/docs/Script API/interfaces/Backend_Script_API._internal_.CallSite.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.CallSite.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.CallSite.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.Cancel.html b/docs/Script API/interfaces/Backend_Script_API._internal_.Cancel.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.Cancel.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.Cancel.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.CancelStatic.html b/docs/Script API/interfaces/Backend_Script_API._internal_.CancelStatic.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.CancelStatic.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.CancelStatic.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.CancelToken.html b/docs/Script API/interfaces/Backend_Script_API._internal_.CancelToken.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.CancelToken.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.CancelToken.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.CancelTokenSource.html b/docs/Script API/interfaces/Backend_Script_API._internal_.CancelTokenSource.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.CancelTokenSource.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.CancelTokenSource.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.CancelTokenStatic.html b/docs/Script API/interfaces/Backend_Script_API._internal_.CancelTokenStatic.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.CancelTokenStatic.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.CancelTokenStatic.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.Canceler.html b/docs/Script API/interfaces/Backend_Script_API._internal_.Canceler.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.Canceler.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.Canceler.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.Cheerio.html b/docs/Script API/interfaces/Backend_Script_API._internal_.Cheerio.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.Cheerio.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.Cheerio.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.CheerioAPI.html b/docs/Script API/interfaces/Backend_Script_API._internal_.CheerioAPI.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.CheerioAPI.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.CheerioAPI.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.CheerioParserOptions.html b/docs/Script API/interfaces/Backend_Script_API._internal_.CheerioParserOptions.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.CheerioParserOptions.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.CheerioParserOptions.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.CloneResponse.html b/docs/Script API/interfaces/Backend_Script_API._internal_.CloneResponse.html similarity index 95% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.CloneResponse.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.CloneResponse.html index 9dbc2894a..3af1f9f36 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.CloneResponse.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.CloneResponse.html @@ -1,5 +1,5 @@ -CloneResponse | trilium
                                                                                    trilium
                                                                                      Preparing search index...

                                                                                      Interface CloneResponse

                                                                                      interface CloneResponse {
                                                                                          branchId?: string;
                                                                                          message?: string;
                                                                                          notePath?: string;
                                                                                          success: boolean;
                                                                                      }
                                                                                      Index

                                                                                      Properties

                                                                                      branchId? +CloneResponse | trilium
                                                                                      trilium
                                                                                        Preparing search index...

                                                                                        Interface CloneResponse

                                                                                        interface CloneResponse {
                                                                                            branchId?: string;
                                                                                            message?: string;
                                                                                            notePath?: string;
                                                                                            success: boolean;
                                                                                        }
                                                                                        Index

                                                                                        Properties

                                                                                        branchId? message? notePath? success -

                                                                                        Properties

                                                                                        branchId?: string
                                                                                        message?: string
                                                                                        notePath?: string
                                                                                        success: boolean

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Properties
                                                                                        +

                                                                                        Properties

                                                                                        branchId?: string
                                                                                        message?: string
                                                                                        notePath?: string
                                                                                        success: boolean

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Properties
                                                                                        diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.CommentElement.html b/docs/Script API/interfaces/Backend_Script_API._internal_.CommentElement.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.CommentElement.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.CommentElement.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-1.html b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-1.html similarity index 96% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-1.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-1.html index 6de532854..67bebd170 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-1.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-1.html @@ -1,3 +1,3 @@ -ContentOpts | trilium
                                                                                        trilium
                                                                                          Preparing search index...

                                                                                          Interface ContentOpts

                                                                                          interface ContentOpts {
                                                                                              forceFrontendReload?: boolean;
                                                                                              forceSave?: boolean;
                                                                                          }
                                                                                          Index

                                                                                          Properties

                                                                                          forceFrontendReload? +ContentOpts | trilium
                                                                                          trilium
                                                                                            Preparing search index...

                                                                                            Interface ContentOpts

                                                                                            interface ContentOpts {
                                                                                                forceFrontendReload?: boolean;
                                                                                                forceSave?: boolean;
                                                                                            }
                                                                                            Index

                                                                                            Properties

                                                                                            forceFrontendReload? forceSave? -

                                                                                            Properties

                                                                                            forceFrontendReload?: boolean
                                                                                            forceSave?: boolean

                                                                                            Settings

                                                                                            Member Visibility

                                                                                            On This Page

                                                                                            Properties
                                                                                            +

                                                                                            Properties

                                                                                            forceFrontendReload?: boolean
                                                                                            forceSave?: boolean

                                                                                            Settings

                                                                                            Member Visibility

                                                                                            On This Page

                                                                                            Properties
                                                                                            diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-2.html b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-2.html similarity index 96% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-2.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-2.html index aa063a8b7..cd3096a8e 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-2.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-2.html @@ -1,6 +1,6 @@ -ContentOpts | trilium
                                                                                            trilium
                                                                                              Preparing search index...

                                                                                              Interface ContentOpts

                                                                                              interface ContentOpts {
                                                                                                  forceFrontendReload?: boolean;
                                                                                                  forceFullSave?: boolean;
                                                                                                  forceSave?: boolean;
                                                                                              }
                                                                                              Index

                                                                                              Properties

                                                                                              forceFrontendReload? +ContentOpts | trilium
                                                                                              trilium
                                                                                                Preparing search index...

                                                                                                Interface ContentOpts

                                                                                                interface ContentOpts {
                                                                                                    forceFrontendReload?: boolean;
                                                                                                    forceFullSave?: boolean;
                                                                                                    forceSave?: boolean;
                                                                                                }
                                                                                                Index

                                                                                                Properties

                                                                                                forceFrontendReload? forceFullSave? forceSave?

                                                                                                Properties

                                                                                                forceFrontendReload?: boolean

                                                                                                override frontend heuristics on when to reload, instruct to reload

                                                                                                -
                                                                                                forceFullSave?: boolean

                                                                                                will also save this BAttachment entity

                                                                                                -
                                                                                                forceSave?: boolean

                                                                                                Settings

                                                                                                Member Visibility

                                                                                                On This Page

                                                                                                Properties
                                                                                                +
                                                                                                forceFullSave?: boolean

                                                                                                will also save this BAttachment entity

                                                                                                +
                                                                                                forceSave?: boolean

                                                                                                Settings

                                                                                                Member Visibility

                                                                                                On This Page

                                                                                                Properties
                                                                                                diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-3.html b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-3.html similarity index 97% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-3.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-3.html index 1c3e3a6a4..7249d0206 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-3.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-3.html @@ -1,3 +1,3 @@ -ContentOpts | trilium
                                                                                                trilium
                                                                                                  Preparing search index...

                                                                                                  Interface ContentOpts

                                                                                                  interface ContentOpts {
                                                                                                      forceSave?: boolean;
                                                                                                  }
                                                                                                  Index

                                                                                                  Properties

                                                                                                  forceSave? +ContentOpts | trilium
                                                                                                  trilium
                                                                                                    Preparing search index...

                                                                                                    Interface ContentOpts

                                                                                                    interface ContentOpts {
                                                                                                        forceSave?: boolean;
                                                                                                    }
                                                                                                    Index

                                                                                                    Properties

                                                                                                    forceSave?

                                                                                                    Properties

                                                                                                    forceSave?: boolean

                                                                                                    will also save this BRevision entity

                                                                                                    -

                                                                                                    Settings

                                                                                                    Member Visibility

                                                                                                    On This Page

                                                                                                    Properties
                                                                                                    +

                                                                                                    Settings

                                                                                                    Member Visibility

                                                                                                    On This Page

                                                                                                    Properties
                                                                                                    diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts.html b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts.html similarity index 98% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts.html index d1d657adb..1b4ae8edb 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts.html @@ -1,5 +1,5 @@ -ContentOpts | trilium
                                                                                                    trilium
                                                                                                      Preparing search index...

                                                                                                      Interface ContentOpts

                                                                                                      interface ContentOpts {
                                                                                                          forceFrontendReload?: boolean;
                                                                                                          forceSave?: boolean;
                                                                                                      }
                                                                                                      Index

                                                                                                      Properties

                                                                                                      forceFrontendReload? +ContentOpts | trilium
                                                                                                      trilium
                                                                                                        Preparing search index...

                                                                                                        Interface ContentOpts

                                                                                                        interface ContentOpts {
                                                                                                            forceFrontendReload?: boolean;
                                                                                                            forceSave?: boolean;
                                                                                                        }
                                                                                                        Index

                                                                                                        Properties

                                                                                                        forceFrontendReload? forceSave?

                                                                                                        Properties

                                                                                                        forceFrontendReload?: boolean

                                                                                                        override frontend heuristics on when to reload, instruct to reload

                                                                                                        -
                                                                                                        forceSave?: boolean

                                                                                                        will also save this BNote entity

                                                                                                        -

                                                                                                        Settings

                                                                                                        Member Visibility

                                                                                                        On This Page

                                                                                                        Properties
                                                                                                        +
                                                                                                        forceSave?: boolean

                                                                                                        will also save this BNote entity

                                                                                                        +

                                                                                                        Settings

                                                                                                        Member Visibility

                                                                                                        On This Page

                                                                                                        Properties
                                                                                                        diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.ConvertOpts.html b/docs/Script API/interfaces/Backend_Script_API._internal_.ConvertOpts.html similarity index 97% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.ConvertOpts.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.ConvertOpts.html index 8a3d30fb1..3bceeda3f 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.ConvertOpts.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.ConvertOpts.html @@ -1,3 +1,3 @@ -ConvertOpts | trilium
                                                                                                        trilium
                                                                                                          Preparing search index...

                                                                                                          Interface ConvertOpts

                                                                                                          interface ConvertOpts {
                                                                                                              autoConversion?: boolean;
                                                                                                          }
                                                                                                          Index

                                                                                                          Properties

                                                                                                          autoConversion? +ConvertOpts | trilium
                                                                                                          trilium
                                                                                                            Preparing search index...

                                                                                                            Interface ConvertOpts

                                                                                                            interface ConvertOpts {
                                                                                                                autoConversion?: boolean;
                                                                                                            }
                                                                                                            Index

                                                                                                            Properties

                                                                                                            autoConversion?

                                                                                                            Properties

                                                                                                            autoConversion?: boolean

                                                                                                            if true, the action is not triggered by user, but e.g. by migration, and only perfect candidates will be migrated

                                                                                                            -

                                                                                                            Settings

                                                                                                            Member Visibility

                                                                                                            On This Page

                                                                                                            Properties
                                                                                                            +

                                                                                                            Settings

                                                                                                            Member Visibility

                                                                                                            On This Page

                                                                                                            Properties
                                                                                                            diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.CreateAxiosDefaults.html b/docs/Script API/interfaces/Backend_Script_API._internal_.CreateAxiosDefaults.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.CreateAxiosDefaults.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.CreateAxiosDefaults.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.CustomParamsSerializer.html b/docs/Script API/interfaces/Backend_Script_API._internal_.CustomParamsSerializer.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.CustomParamsSerializer.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.CustomParamsSerializer.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.DefinitionObject.html b/docs/Script API/interfaces/Backend_Script_API._internal_.DefinitionObject.html similarity index 95% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.DefinitionObject.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.DefinitionObject.html index 3e9c63c1e..0bf430620 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.DefinitionObject.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.DefinitionObject.html @@ -1,7 +1,7 @@ -DefinitionObject | trilium
                                                                                                            trilium
                                                                                                              Preparing search index...

                                                                                                              Interface DefinitionObject

                                                                                                              interface DefinitionObject {
                                                                                                                  inverseRelation?: string;
                                                                                                                  isPromoted?: boolean;
                                                                                                                  labelType?: string;
                                                                                                                  multiplicity?: string;
                                                                                                                  numberPrecision?: number;
                                                                                                                  promotedAlias?: string;
                                                                                                              }
                                                                                                              Index

                                                                                                              Properties

                                                                                                              inverseRelation? +DefinitionObject | trilium
                                                                                                              trilium
                                                                                                                Preparing search index...

                                                                                                                Interface DefinitionObject

                                                                                                                interface DefinitionObject {
                                                                                                                    inverseRelation?: string;
                                                                                                                    isPromoted?: boolean;
                                                                                                                    labelType?: string;
                                                                                                                    multiplicity?: string;
                                                                                                                    numberPrecision?: number;
                                                                                                                    promotedAlias?: string;
                                                                                                                }
                                                                                                                Index

                                                                                                                Properties

                                                                                                                inverseRelation? isPromoted? labelType? multiplicity? numberPrecision? promotedAlias? -

                                                                                                                Properties

                                                                                                                inverseRelation?: string
                                                                                                                isPromoted?: boolean
                                                                                                                labelType?: string
                                                                                                                multiplicity?: string
                                                                                                                numberPrecision?: number
                                                                                                                promotedAlias?: string

                                                                                                                Settings

                                                                                                                Member Visibility

                                                                                                                On This Page

                                                                                                                Properties
                                                                                                                +

                                                                                                                Properties

                                                                                                                inverseRelation?: string
                                                                                                                isPromoted?: boolean
                                                                                                                labelType?: string
                                                                                                                multiplicity?: string
                                                                                                                numberPrecision?: number
                                                                                                                promotedAlias?: string

                                                                                                                Settings

                                                                                                                Member Visibility

                                                                                                                On This Page

                                                                                                                Properties
                                                                                                                diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.Disposable.html b/docs/Script API/interfaces/Backend_Script_API._internal_.Disposable.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.Disposable.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.Disposable.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.EtapiTokenRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.EtapiTokenRow.html similarity index 95% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.EtapiTokenRow.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.EtapiTokenRow.html index ad6cdf6a2..59a6d75f0 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.EtapiTokenRow.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.EtapiTokenRow.html @@ -1,7 +1,7 @@ -EtapiTokenRow | trilium
                                                                                                                trilium
                                                                                                                  Preparing search index...

                                                                                                                  Interface EtapiTokenRow

                                                                                                                  interface EtapiTokenRow {
                                                                                                                      etapiTokenId?: string;
                                                                                                                      isDeleted?: boolean;
                                                                                                                      name: string;
                                                                                                                      tokenHash: string;
                                                                                                                      utcDateCreated?: string;
                                                                                                                      utcDateModified?: string;
                                                                                                                  }
                                                                                                                  Index

                                                                                                                  Properties

                                                                                                                  etapiTokenId? +EtapiTokenRow | trilium
                                                                                                                  trilium
                                                                                                                    Preparing search index...

                                                                                                                    Interface EtapiTokenRow

                                                                                                                    interface EtapiTokenRow {
                                                                                                                        etapiTokenId?: string;
                                                                                                                        isDeleted?: boolean;
                                                                                                                        name: string;
                                                                                                                        tokenHash: string;
                                                                                                                        utcDateCreated?: string;
                                                                                                                        utcDateModified?: string;
                                                                                                                    }
                                                                                                                    Index

                                                                                                                    Properties

                                                                                                                    etapiTokenId? isDeleted? name tokenHash utcDateCreated? utcDateModified? -

                                                                                                                    Properties

                                                                                                                    etapiTokenId?: string
                                                                                                                    isDeleted?: boolean
                                                                                                                    name: string
                                                                                                                    tokenHash: string
                                                                                                                    utcDateCreated?: string
                                                                                                                    utcDateModified?: string

                                                                                                                    Settings

                                                                                                                    Member Visibility

                                                                                                                    On This Page

                                                                                                                    Properties
                                                                                                                    +

                                                                                                                    Properties

                                                                                                                    etapiTokenId?: string
                                                                                                                    isDeleted?: boolean
                                                                                                                    name: string
                                                                                                                    tokenHash: string
                                                                                                                    utcDateCreated?: string
                                                                                                                    utcDateModified?: string

                                                                                                                    Settings

                                                                                                                    Member Visibility

                                                                                                                    On This Page

                                                                                                                    Properties
                                                                                                                    diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.Abortable.html b/docs/Script API/interfaces/Backend_Script_API._internal_.EventEmitter.Abortable.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.Abortable.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.EventEmitter.Abortable.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResourceOptions.html b/docs/Script API/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResourceOptions.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResourceOptions.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResourceOptions.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterReferencingAsyncResource.html b/docs/Script API/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterReferencingAsyncResource.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterReferencingAsyncResource.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterReferencingAsyncResource.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.html b/docs/Script API/interfaces/Backend_Script_API._internal_.EventEmitter.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.EventEmitter.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitterOptions.html b/docs/Script API/interfaces/Backend_Script_API._internal_.EventEmitterOptions.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitterOptions.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.EventEmitterOptions.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.FormDataVisitorHelpers.html b/docs/Script API/interfaces/Backend_Script_API._internal_.FormDataVisitorHelpers.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.FormDataVisitorHelpers.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.FormDataVisitorHelpers.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.FormSerializerOptions.html b/docs/Script API/interfaces/Backend_Script_API._internal_.FormSerializerOptions.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.FormSerializerOptions.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.FormSerializerOptions.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.GenericAbortSignal.html b/docs/Script API/interfaces/Backend_Script_API._internal_.GenericAbortSignal.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.GenericAbortSignal.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.GenericAbortSignal.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.GenericFormData.html b/docs/Script API/interfaces/Backend_Script_API._internal_.GenericFormData.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.GenericFormData.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.GenericFormData.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.GenericHTMLFormElement.html b/docs/Script API/interfaces/Backend_Script_API._internal_.GenericHTMLFormElement.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.GenericHTMLFormElement.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.GenericHTMLFormElement.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.GetByIdOpts.html b/docs/Script API/interfaces/Backend_Script_API._internal_.GetByIdOpts.html similarity index 96% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.GetByIdOpts.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.GetByIdOpts.html index 5bfeb853f..84270f15f 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.GetByIdOpts.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.GetByIdOpts.html @@ -1,2 +1,2 @@ -GetByIdOpts | trilium
                                                                                                                    trilium
                                                                                                                      Preparing search index...

                                                                                                                      Interface GetByIdOpts

                                                                                                                      interface GetByIdOpts {
                                                                                                                          includeContentLength?: boolean;
                                                                                                                      }
                                                                                                                      Index

                                                                                                                      Properties

                                                                                                                      includeContentLength? -

                                                                                                                      Properties

                                                                                                                      includeContentLength?: boolean

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      On This Page

                                                                                                                      Properties
                                                                                                                      +GetByIdOpts | trilium
                                                                                                                      trilium
                                                                                                                        Preparing search index...

                                                                                                                        Interface GetByIdOpts

                                                                                                                        interface GetByIdOpts {
                                                                                                                            includeContentLength?: boolean;
                                                                                                                        }
                                                                                                                        Index

                                                                                                                        Properties

                                                                                                                        includeContentLength? +

                                                                                                                        Properties

                                                                                                                        includeContentLength?: boolean

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        On This Page

                                                                                                                        Properties
                                                                                                                        diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.HeadersDefaults.html b/docs/Script API/interfaces/Backend_Script_API._internal_.HeadersDefaults.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.HeadersDefaults.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.HeadersDefaults.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.InternalAxiosRequestConfig.html b/docs/Script API/interfaces/Backend_Script_API._internal_.InternalAxiosRequestConfig.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.InternalAxiosRequestConfig.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.InternalAxiosRequestConfig.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.IterableIterator.html b/docs/Script API/interfaces/Backend_Script_API._internal_.IterableIterator.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.IterableIterator.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.IterableIterator.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.Iterator.html b/docs/Script API/interfaces/Backend_Script_API._internal_.Iterator.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.Iterator.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.Iterator.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.IteratorReturnResult.html b/docs/Script API/interfaces/Backend_Script_API._internal_.IteratorReturnResult.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.IteratorReturnResult.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.IteratorReturnResult.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.IteratorYieldResult.html b/docs/Script API/interfaces/Backend_Script_API._internal_.IteratorYieldResult.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.IteratorYieldResult.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.IteratorYieldResult.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.LookupAddressEntry.html b/docs/Script API/interfaces/Backend_Script_API._internal_.LookupAddressEntry.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.LookupAddressEntry.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.LookupAddressEntry.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteAndBranch.html b/docs/Script API/interfaces/Backend_Script_API._internal_.NoteAndBranch.html similarity index 96% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.NoteAndBranch.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.NoteAndBranch.html index 79248c8f9..d84ff7c50 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteAndBranch.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.NoteAndBranch.html @@ -1,4 +1,4 @@ -NoteAndBranch | trilium
                                                                                                                        trilium
                                                                                                                          Preparing search index...

                                                                                                                          Interface NoteAndBranch

                                                                                                                          interface NoteAndBranch {
                                                                                                                              branch: BBranch;
                                                                                                                              note: BNote;
                                                                                                                          }
                                                                                                                          Index

                                                                                                                          Properties

                                                                                                                          branch +NoteAndBranch | trilium
                                                                                                                          trilium
                                                                                                                            Preparing search index...

                                                                                                                            Interface NoteAndBranch

                                                                                                                            interface NoteAndBranch {
                                                                                                                                branch: BBranch;
                                                                                                                                note: BNote;
                                                                                                                            }
                                                                                                                            Index

                                                                                                                            Properties

                                                                                                                            branch note

                                                                                                                            Properties

                                                                                                                            branch: BBranch

                                                                                                                            object having "note" and "branch" keys representing respective objects

                                                                                                                            -
                                                                                                                            note: BNote

                                                                                                                            Settings

                                                                                                                            Member Visibility

                                                                                                                            On This Page

                                                                                                                            Properties
                                                                                                                            +
                                                                                                                            note: BNote

                                                                                                                            Settings

                                                                                                                            Member Visibility

                                                                                                                            On This Page

                                                                                                                            Properties
                                                                                                                            diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteParams.html b/docs/Script API/interfaces/Backend_Script_API._internal_.NoteParams.html similarity index 95% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.NoteParams.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.NoteParams.html index 957695954..ef42a08de 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteParams.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.NoteParams.html @@ -1,4 +1,4 @@ -NoteParams | trilium
                                                                                                                            trilium
                                                                                                                              Preparing search index...

                                                                                                                              Interface NoteParams

                                                                                                                              interface NoteParams {
                                                                                                                                  branchId?: string;
                                                                                                                                  content: string | Buffer<ArrayBufferLike>;
                                                                                                                                  dateCreated?: string;
                                                                                                                                  ignoreForbiddenParents?: boolean;
                                                                                                                                  isExpanded?: boolean;
                                                                                                                                  isProtected?: boolean;
                                                                                                                                  mime?: string;
                                                                                                                                  noteId?: string;
                                                                                                                                  notePosition?: number;
                                                                                                                                  parentNoteId: string;
                                                                                                                                  prefix?: string;
                                                                                                                                  target?: "into";
                                                                                                                                  templateNoteId?: string;
                                                                                                                                  title: string;
                                                                                                                                  type:
                                                                                                                                      | "canvas"
                                                                                                                                      | "code"
                                                                                                                                      | "search"
                                                                                                                                      | "image"
                                                                                                                                      | "text"
                                                                                                                                      | "file"
                                                                                                                                      | "noteMap"
                                                                                                                                      | "launcher"
                                                                                                                                      | "doc"
                                                                                                                                      | "contentWidget"
                                                                                                                                      | "relationMap"
                                                                                                                                      | "render"
                                                                                                                                      | "mermaid"
                                                                                                                                      | "book"
                                                                                                                                      | "webView"
                                                                                                                                      | "mindMap"
                                                                                                                                      | "geoMap";
                                                                                                                                  utcDateCreated?: string;
                                                                                                                              }
                                                                                                                              Index

                                                                                                                              Properties

                                                                                                                              branchId? +NoteParams | trilium
                                                                                                                              trilium
                                                                                                                                Preparing search index...

                                                                                                                                Interface NoteParams

                                                                                                                                interface NoteParams {
                                                                                                                                    branchId?: string;
                                                                                                                                    content: string | Buffer<ArrayBufferLike>;
                                                                                                                                    dateCreated?: string;
                                                                                                                                    ignoreForbiddenParents?: boolean;
                                                                                                                                    isExpanded?: boolean;
                                                                                                                                    isProtected?: boolean;
                                                                                                                                    mime?: string;
                                                                                                                                    noteId?: string;
                                                                                                                                    notePosition?: number;
                                                                                                                                    parentNoteId: string;
                                                                                                                                    prefix?: string;
                                                                                                                                    target?: "into";
                                                                                                                                    templateNoteId?: string;
                                                                                                                                    title: string;
                                                                                                                                    type:
                                                                                                                                        | "canvas"
                                                                                                                                        | "code"
                                                                                                                                        | "search"
                                                                                                                                        | "image"
                                                                                                                                        | "text"
                                                                                                                                        | "file"
                                                                                                                                        | "noteMap"
                                                                                                                                        | "launcher"
                                                                                                                                        | "doc"
                                                                                                                                        | "contentWidget"
                                                                                                                                        | "relationMap"
                                                                                                                                        | "render"
                                                                                                                                        | "mermaid"
                                                                                                                                        | "book"
                                                                                                                                        | "webView"
                                                                                                                                        | "mindMap"
                                                                                                                                        | "geoMap";
                                                                                                                                    utcDateCreated?: string;
                                                                                                                                }
                                                                                                                                Index

                                                                                                                                Properties

                                                                                                                                branchId? content dateCreated? ignoreForbiddenParents? @@ -14,11 +14,11 @@ title type utcDateCreated? -

                                                                                                                                Properties

                                                                                                                                branchId?: string

                                                                                                                                content

                                                                                                                                content: string | Buffer<ArrayBufferLike>
                                                                                                                                dateCreated?: string
                                                                                                                                ignoreForbiddenParents?: boolean
                                                                                                                                isExpanded?: boolean

                                                                                                                                default is false

                                                                                                                                -
                                                                                                                                isProtected?: boolean

                                                                                                                                default is false

                                                                                                                                -
                                                                                                                                mime?: string

                                                                                                                                default value is derived from default mimes for type

                                                                                                                                -
                                                                                                                                noteId?: string

                                                                                                                                optionally can force specific noteId

                                                                                                                                -
                                                                                                                                notePosition?: number

                                                                                                                                default is the last existing notePosition in a parent + 10

                                                                                                                                -
                                                                                                                                parentNoteId: string
                                                                                                                                prefix?: string

                                                                                                                                default is empty string

                                                                                                                                -
                                                                                                                                target?: "into"
                                                                                                                                templateNoteId?: string
                                                                                                                                title: string
                                                                                                                                type:
                                                                                                                                    | "canvas"
                                                                                                                                    | "code"
                                                                                                                                    | "search"
                                                                                                                                    | "image"
                                                                                                                                    | "text"
                                                                                                                                    | "file"
                                                                                                                                    | "noteMap"
                                                                                                                                    | "launcher"
                                                                                                                                    | "doc"
                                                                                                                                    | "contentWidget"
                                                                                                                                    | "relationMap"
                                                                                                                                    | "render"
                                                                                                                                    | "mermaid"
                                                                                                                                    | "book"
                                                                                                                                    | "webView"
                                                                                                                                    | "mindMap"
                                                                                                                                    | "geoMap"

                                                                                                                                text, code, file, image, search, book, relationMap, canvas, webView

                                                                                                                                -
                                                                                                                                utcDateCreated?: string

                                                                                                                                Settings

                                                                                                                                Member Visibility

                                                                                                                                On This Page

                                                                                                                                Properties
                                                                                                                                +

                                                                                                                                Properties

                                                                                                                                branchId?: string

                                                                                                                                content

                                                                                                                                content: string | Buffer<ArrayBufferLike>
                                                                                                                                dateCreated?: string
                                                                                                                                ignoreForbiddenParents?: boolean
                                                                                                                                isExpanded?: boolean

                                                                                                                                default is false

                                                                                                                                +
                                                                                                                                isProtected?: boolean

                                                                                                                                default is false

                                                                                                                                +
                                                                                                                                mime?: string

                                                                                                                                default value is derived from default mimes for type

                                                                                                                                +
                                                                                                                                noteId?: string

                                                                                                                                optionally can force specific noteId

                                                                                                                                +
                                                                                                                                notePosition?: number

                                                                                                                                default is the last existing notePosition in a parent + 10

                                                                                                                                +
                                                                                                                                parentNoteId: string
                                                                                                                                prefix?: string

                                                                                                                                default is empty string

                                                                                                                                +
                                                                                                                                target?: "into"
                                                                                                                                templateNoteId?: string
                                                                                                                                title: string
                                                                                                                                type:
                                                                                                                                    | "canvas"
                                                                                                                                    | "code"
                                                                                                                                    | "search"
                                                                                                                                    | "image"
                                                                                                                                    | "text"
                                                                                                                                    | "file"
                                                                                                                                    | "noteMap"
                                                                                                                                    | "launcher"
                                                                                                                                    | "doc"
                                                                                                                                    | "contentWidget"
                                                                                                                                    | "relationMap"
                                                                                                                                    | "render"
                                                                                                                                    | "mermaid"
                                                                                                                                    | "book"
                                                                                                                                    | "webView"
                                                                                                                                    | "mindMap"
                                                                                                                                    | "geoMap"

                                                                                                                                text, code, file, image, search, book, relationMap, canvas, webView

                                                                                                                                +
                                                                                                                                utcDateCreated?: string

                                                                                                                                Settings

                                                                                                                                Member Visibility

                                                                                                                                On This Page

                                                                                                                                Properties
                                                                                                                                diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.NotePathRecord.html b/docs/Script API/interfaces/Backend_Script_API._internal_.NotePathRecord.html similarity index 95% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.NotePathRecord.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.NotePathRecord.html index f56771203..48cfc34e9 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.NotePathRecord.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.NotePathRecord.html @@ -1,5 +1,5 @@ -NotePathRecord | trilium
                                                                                                                                trilium
                                                                                                                                  Preparing search index...

                                                                                                                                  Interface NotePathRecord

                                                                                                                                  interface NotePathRecord {
                                                                                                                                      isArchived: boolean;
                                                                                                                                      isHidden: boolean;
                                                                                                                                      isInHoistedSubTree: boolean;
                                                                                                                                      notePath: string[];
                                                                                                                                  }
                                                                                                                                  Index

                                                                                                                                  Properties

                                                                                                                                  isArchived +NotePathRecord | trilium
                                                                                                                                  trilium
                                                                                                                                    Preparing search index...

                                                                                                                                    Interface NotePathRecord

                                                                                                                                    interface NotePathRecord {
                                                                                                                                        isArchived: boolean;
                                                                                                                                        isHidden: boolean;
                                                                                                                                        isInHoistedSubTree: boolean;
                                                                                                                                        notePath: string[];
                                                                                                                                    }
                                                                                                                                    Index

                                                                                                                                    Properties

                                                                                                                                    isArchived isHidden isInHoistedSubTree notePath -

                                                                                                                                    Properties

                                                                                                                                    isArchived: boolean
                                                                                                                                    isHidden: boolean
                                                                                                                                    isInHoistedSubTree: boolean
                                                                                                                                    notePath: string[]

                                                                                                                                    Settings

                                                                                                                                    Member Visibility

                                                                                                                                    On This Page

                                                                                                                                    Properties
                                                                                                                                    +

                                                                                                                                    Properties

                                                                                                                                    isArchived: boolean
                                                                                                                                    isHidden: boolean
                                                                                                                                    isInHoistedSubTree: boolean
                                                                                                                                    notePath: string[]

                                                                                                                                    Settings

                                                                                                                                    Member Visibility

                                                                                                                                    On This Page

                                                                                                                                    Properties
                                                                                                                                    diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.NotePojo.html b/docs/Script API/interfaces/Backend_Script_API._internal_.NotePojo.html similarity index 94% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.NotePojo.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.NotePojo.html index 1dcae35ca..c3f091a10 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.NotePojo.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.NotePojo.html @@ -1,4 +1,4 @@ -NotePojo | trilium
                                                                                                                                    trilium
                                                                                                                                      Preparing search index...

                                                                                                                                      Interface NotePojo

                                                                                                                                      interface NotePojo {
                                                                                                                                          blobId?: string;
                                                                                                                                          dateCreated?: string;
                                                                                                                                          dateModified?: string;
                                                                                                                                          isDeleted: boolean;
                                                                                                                                          isProtected?: boolean;
                                                                                                                                          mime: string;
                                                                                                                                          noteId: string;
                                                                                                                                          title?: string;
                                                                                                                                          type: string;
                                                                                                                                          utcDateCreated: string;
                                                                                                                                          utcDateModified?: string;
                                                                                                                                      }
                                                                                                                                      Index

                                                                                                                                      Properties

                                                                                                                                      blobId? +NotePojo | trilium
                                                                                                                                      trilium
                                                                                                                                        Preparing search index...

                                                                                                                                        Interface NotePojo

                                                                                                                                        interface NotePojo {
                                                                                                                                            blobId?: string;
                                                                                                                                            dateCreated?: string;
                                                                                                                                            dateModified?: string;
                                                                                                                                            isDeleted: boolean;
                                                                                                                                            isProtected?: boolean;
                                                                                                                                            mime: string;
                                                                                                                                            noteId: string;
                                                                                                                                            title?: string;
                                                                                                                                            type: string;
                                                                                                                                            utcDateCreated: string;
                                                                                                                                            utcDateModified?: string;
                                                                                                                                        }
                                                                                                                                        Index

                                                                                                                                        Properties

                                                                                                                                        blobId? dateCreated? dateModified? isDeleted @@ -9,4 +9,4 @@ type utcDateCreated utcDateModified? -

                                                                                                                                        Properties

                                                                                                                                        blobId?: string
                                                                                                                                        dateCreated?: string
                                                                                                                                        dateModified?: string
                                                                                                                                        isDeleted: boolean
                                                                                                                                        isProtected?: boolean
                                                                                                                                        mime: string
                                                                                                                                        noteId: string
                                                                                                                                        title?: string
                                                                                                                                        type: string
                                                                                                                                        utcDateCreated: string
                                                                                                                                        utcDateModified?: string

                                                                                                                                        Settings

                                                                                                                                        Member Visibility

                                                                                                                                        On This Page

                                                                                                                                        Properties
                                                                                                                                        +

                                                                                                                                        Properties

                                                                                                                                        blobId?: string
                                                                                                                                        dateCreated?: string
                                                                                                                                        dateModified?: string
                                                                                                                                        isDeleted: boolean
                                                                                                                                        isProtected?: boolean
                                                                                                                                        mime: string
                                                                                                                                        noteId: string
                                                                                                                                        title?: string
                                                                                                                                        type: string
                                                                                                                                        utcDateCreated: string
                                                                                                                                        utcDateModified?: string

                                                                                                                                        Settings

                                                                                                                                        Member Visibility

                                                                                                                                        On This Page

                                                                                                                                        Properties
                                                                                                                                        diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.NoteRow.html similarity index 95% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.NoteRow.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.NoteRow.html index c102c09a7..85ebfbe17 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteRow.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.NoteRow.html @@ -1,4 +1,4 @@ -NoteRow | trilium
                                                                                                                                        trilium
                                                                                                                                          Preparing search index...

                                                                                                                                          Interface NoteRow

                                                                                                                                          interface NoteRow {
                                                                                                                                              blobId: string;
                                                                                                                                              content?: string | Buffer<ArrayBufferLike>;
                                                                                                                                              dateCreated: string;
                                                                                                                                              dateModified: string;
                                                                                                                                              deleteId: string;
                                                                                                                                              isDeleted: boolean;
                                                                                                                                              isProtected: boolean;
                                                                                                                                              mime: string;
                                                                                                                                              noteId: string;
                                                                                                                                              title: string;
                                                                                                                                              type:
                                                                                                                                                  | "canvas"
                                                                                                                                                  | "code"
                                                                                                                                                  | "search"
                                                                                                                                                  | "image"
                                                                                                                                                  | "text"
                                                                                                                                                  | "file"
                                                                                                                                                  | "noteMap"
                                                                                                                                                  | "launcher"
                                                                                                                                                  | "doc"
                                                                                                                                                  | "contentWidget"
                                                                                                                                                  | "relationMap"
                                                                                                                                                  | "render"
                                                                                                                                                  | "mermaid"
                                                                                                                                                  | "book"
                                                                                                                                                  | "webView"
                                                                                                                                                  | "mindMap"
                                                                                                                                                  | "geoMap";
                                                                                                                                              utcDateCreated: string;
                                                                                                                                              utcDateModified: string;
                                                                                                                                          }
                                                                                                                                          Index

                                                                                                                                          Properties

                                                                                                                                          blobId +NoteRow | trilium
                                                                                                                                          trilium
                                                                                                                                            Preparing search index...

                                                                                                                                            Interface NoteRow

                                                                                                                                            interface NoteRow {
                                                                                                                                                blobId: string;
                                                                                                                                                content?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                dateCreated: string;
                                                                                                                                                dateModified: string;
                                                                                                                                                deleteId: string;
                                                                                                                                                isDeleted: boolean;
                                                                                                                                                isProtected: boolean;
                                                                                                                                                mime: string;
                                                                                                                                                noteId: string;
                                                                                                                                                title: string;
                                                                                                                                                type:
                                                                                                                                                    | "canvas"
                                                                                                                                                    | "code"
                                                                                                                                                    | "search"
                                                                                                                                                    | "image"
                                                                                                                                                    | "text"
                                                                                                                                                    | "file"
                                                                                                                                                    | "noteMap"
                                                                                                                                                    | "launcher"
                                                                                                                                                    | "doc"
                                                                                                                                                    | "contentWidget"
                                                                                                                                                    | "relationMap"
                                                                                                                                                    | "render"
                                                                                                                                                    | "mermaid"
                                                                                                                                                    | "book"
                                                                                                                                                    | "webView"
                                                                                                                                                    | "mindMap"
                                                                                                                                                    | "geoMap";
                                                                                                                                                utcDateCreated: string;
                                                                                                                                                utcDateModified: string;
                                                                                                                                            }
                                                                                                                                            Index

                                                                                                                                            Properties

                                                                                                                                            blobId content? dateCreated dateModified @@ -11,4 +11,4 @@ type utcDateCreated utcDateModified -

                                                                                                                                            Properties

                                                                                                                                            blobId: string

                                                                                                                                            Optionalcontent

                                                                                                                                            content?: string | Buffer<ArrayBufferLike>
                                                                                                                                            dateCreated: string
                                                                                                                                            dateModified: string
                                                                                                                                            deleteId: string
                                                                                                                                            isDeleted: boolean
                                                                                                                                            isProtected: boolean
                                                                                                                                            mime: string
                                                                                                                                            noteId: string
                                                                                                                                            title: string
                                                                                                                                            type:
                                                                                                                                                | "canvas"
                                                                                                                                                | "code"
                                                                                                                                                | "search"
                                                                                                                                                | "image"
                                                                                                                                                | "text"
                                                                                                                                                | "file"
                                                                                                                                                | "noteMap"
                                                                                                                                                | "launcher"
                                                                                                                                                | "doc"
                                                                                                                                                | "contentWidget"
                                                                                                                                                | "relationMap"
                                                                                                                                                | "render"
                                                                                                                                                | "mermaid"
                                                                                                                                                | "book"
                                                                                                                                                | "webView"
                                                                                                                                                | "mindMap"
                                                                                                                                                | "geoMap"
                                                                                                                                            utcDateCreated: string
                                                                                                                                            utcDateModified: string

                                                                                                                                            Settings

                                                                                                                                            Member Visibility

                                                                                                                                            On This Page

                                                                                                                                            Properties
                                                                                                                                            +

                                                                                                                                            Properties

                                                                                                                                            blobId: string

                                                                                                                                            Optionalcontent

                                                                                                                                            content?: string | Buffer<ArrayBufferLike>
                                                                                                                                            dateCreated: string
                                                                                                                                            dateModified: string
                                                                                                                                            deleteId: string
                                                                                                                                            isDeleted: boolean
                                                                                                                                            isProtected: boolean
                                                                                                                                            mime: string
                                                                                                                                            noteId: string
                                                                                                                                            title: string
                                                                                                                                            type:
                                                                                                                                                | "canvas"
                                                                                                                                                | "code"
                                                                                                                                                | "search"
                                                                                                                                                | "image"
                                                                                                                                                | "text"
                                                                                                                                                | "file"
                                                                                                                                                | "noteMap"
                                                                                                                                                | "launcher"
                                                                                                                                                | "doc"
                                                                                                                                                | "contentWidget"
                                                                                                                                                | "relationMap"
                                                                                                                                                | "render"
                                                                                                                                                | "mermaid"
                                                                                                                                                | "book"
                                                                                                                                                | "webView"
                                                                                                                                                | "mindMap"
                                                                                                                                                | "geoMap"
                                                                                                                                            utcDateCreated: string
                                                                                                                                            utcDateModified: string

                                                                                                                                            Settings

                                                                                                                                            Member Visibility

                                                                                                                                            On This Page

                                                                                                                                            Properties
                                                                                                                                            diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.Object.html b/docs/Script API/interfaces/Backend_Script_API._internal_.Object.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.Object.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.Object.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.OptionRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.OptionRow.html similarity index 97% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.OptionRow.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.OptionRow.html index 49410f8c4..f3e753110 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.OptionRow.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.OptionRow.html @@ -1,11 +1,11 @@ OptionRow | trilium
                                                                                                                                            trilium
                                                                                                                                              Preparing search index...

                                                                                                                                              Interface OptionRow

                                                                                                                                              Database representation of an option.

                                                                                                                                              Options are key-value pairs that are used to store information such as user preferences (for example the current theme, sync server information), but also information about the state of the application).

                                                                                                                                              -
                                                                                                                                              interface OptionRow {
                                                                                                                                                  isSynced: boolean;
                                                                                                                                                  name: string;
                                                                                                                                                  utcDateModified?: string;
                                                                                                                                                  value: string;
                                                                                                                                              }
                                                                                                                                              Index

                                                                                                                                              Properties

                                                                                                                                              isSynced +
                                                                                                                                              interface OptionRow {
                                                                                                                                                  isSynced: boolean;
                                                                                                                                                  name: string;
                                                                                                                                                  utcDateModified?: string;
                                                                                                                                                  value: string;
                                                                                                                                              }
                                                                                                                                              Index

                                                                                                                                              Properties

                                                                                                                                              isSynced name utcDateModified? value

                                                                                                                                              Properties

                                                                                                                                              isSynced: boolean

                                                                                                                                              true if the value should be synced across multiple instances (e.g. locale) or false if it should be local-only (e.g. theme).

                                                                                                                                              -
                                                                                                                                              name: string

                                                                                                                                              The name of the option.

                                                                                                                                              -
                                                                                                                                              utcDateModified?: string
                                                                                                                                              value: string

                                                                                                                                              The value of the option.

                                                                                                                                              -

                                                                                                                                              Settings

                                                                                                                                              Member Visibility

                                                                                                                                              On This Page

                                                                                                                                              Properties
                                                                                                                                              +
                                                                                                                                              name: string

                                                                                                                                              The name of the option.

                                                                                                                                              +
                                                                                                                                              utcDateModified?: string
                                                                                                                                              value: string

                                                                                                                                              The value of the option.

                                                                                                                                              +

                                                                                                                                              Settings

                                                                                                                                              Member Visibility

                                                                                                                                              On This Page

                                                                                                                                              Properties
                                                                                                                                              diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.ParamEncoder.html b/docs/Script API/interfaces/Backend_Script_API._internal_.ParamEncoder.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.ParamEncoder.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.ParamEncoder.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.ParamsSerializerOptions.html b/docs/Script API/interfaces/Backend_Script_API._internal_.ParamsSerializerOptions.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.ParamsSerializerOptions.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.ParamsSerializerOptions.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.RawAxiosHeaders.html b/docs/Script API/interfaces/Backend_Script_API._internal_.RawAxiosHeaders.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.RawAxiosHeaders.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.RawAxiosHeaders.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.Relationship.html b/docs/Script API/interfaces/Backend_Script_API._internal_.Relationship.html similarity index 96% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.Relationship.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.Relationship.html index 1fae12caf..8443b953d 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.Relationship.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.Relationship.html @@ -1,3 +1,3 @@ -Relationship | trilium
                                                                                                                                              trilium
                                                                                                                                                Preparing search index...

                                                                                                                                                Interface Relationship

                                                                                                                                                interface Relationship {
                                                                                                                                                    childNoteId: string;
                                                                                                                                                    parentNoteId: string;
                                                                                                                                                }
                                                                                                                                                Index

                                                                                                                                                Properties

                                                                                                                                                childNoteId +Relationship | trilium
                                                                                                                                                trilium
                                                                                                                                                  Preparing search index...

                                                                                                                                                  Interface Relationship

                                                                                                                                                  interface Relationship {
                                                                                                                                                      childNoteId: string;
                                                                                                                                                      parentNoteId: string;
                                                                                                                                                  }
                                                                                                                                                  Index

                                                                                                                                                  Properties

                                                                                                                                                  childNoteId parentNoteId -

                                                                                                                                                  Properties

                                                                                                                                                  childNoteId: string
                                                                                                                                                  parentNoteId: string

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Properties
                                                                                                                                                  +

                                                                                                                                                  Properties

                                                                                                                                                  childNoteId: string
                                                                                                                                                  parentNoteId: string

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Properties
                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.RevisionRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.RevisionRow.html similarity index 94% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.RevisionRow.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.RevisionRow.html index 068ec9e8f..3cd7e23fe 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.RevisionRow.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.RevisionRow.html @@ -1,4 +1,4 @@ -RevisionRow | trilium
                                                                                                                                                  trilium
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Interface RevisionRow

                                                                                                                                                    interface RevisionRow {
                                                                                                                                                        blobId?: string;
                                                                                                                                                        contentLength?: number;
                                                                                                                                                        dateCreated: string;
                                                                                                                                                        dateLastEdited?: string;
                                                                                                                                                        isProtected?: boolean;
                                                                                                                                                        mime: string;
                                                                                                                                                        noteId: string;
                                                                                                                                                        revisionId?: string;
                                                                                                                                                        title: string;
                                                                                                                                                        type:
                                                                                                                                                            | "canvas"
                                                                                                                                                            | "code"
                                                                                                                                                            | "search"
                                                                                                                                                            | "image"
                                                                                                                                                            | "text"
                                                                                                                                                            | "file"
                                                                                                                                                            | "noteMap"
                                                                                                                                                            | "launcher"
                                                                                                                                                            | "doc"
                                                                                                                                                            | "contentWidget"
                                                                                                                                                            | "relationMap"
                                                                                                                                                            | "render"
                                                                                                                                                            | "mermaid"
                                                                                                                                                            | "book"
                                                                                                                                                            | "webView"
                                                                                                                                                            | "mindMap"
                                                                                                                                                            | "geoMap";
                                                                                                                                                        utcDateCreated: string;
                                                                                                                                                        utcDateLastEdited?: string;
                                                                                                                                                        utcDateModified: string;
                                                                                                                                                    }
                                                                                                                                                    Index

                                                                                                                                                    Properties

                                                                                                                                                    blobId? +RevisionRow | trilium
                                                                                                                                                    trilium
                                                                                                                                                      Preparing search index...

                                                                                                                                                      Interface RevisionRow

                                                                                                                                                      interface RevisionRow {
                                                                                                                                                          blobId?: string;
                                                                                                                                                          contentLength?: number;
                                                                                                                                                          dateCreated: string;
                                                                                                                                                          dateLastEdited?: string;
                                                                                                                                                          isProtected?: boolean;
                                                                                                                                                          mime: string;
                                                                                                                                                          noteId: string;
                                                                                                                                                          revisionId?: string;
                                                                                                                                                          title: string;
                                                                                                                                                          type:
                                                                                                                                                              | "canvas"
                                                                                                                                                              | "code"
                                                                                                                                                              | "search"
                                                                                                                                                              | "image"
                                                                                                                                                              | "text"
                                                                                                                                                              | "file"
                                                                                                                                                              | "noteMap"
                                                                                                                                                              | "launcher"
                                                                                                                                                              | "doc"
                                                                                                                                                              | "contentWidget"
                                                                                                                                                              | "relationMap"
                                                                                                                                                              | "render"
                                                                                                                                                              | "mermaid"
                                                                                                                                                              | "book"
                                                                                                                                                              | "webView"
                                                                                                                                                              | "mindMap"
                                                                                                                                                              | "geoMap";
                                                                                                                                                          utcDateCreated: string;
                                                                                                                                                          utcDateLastEdited?: string;
                                                                                                                                                          utcDateModified: string;
                                                                                                                                                      }
                                                                                                                                                      Index

                                                                                                                                                      Properties

                                                                                                                                                      blobId? contentLength? dateCreated dateLastEdited? @@ -11,4 +11,4 @@ utcDateCreated utcDateLastEdited? utcDateModified -

                                                                                                                                                      Properties

                                                                                                                                                      blobId?: string
                                                                                                                                                      contentLength?: number
                                                                                                                                                      dateCreated: string
                                                                                                                                                      dateLastEdited?: string
                                                                                                                                                      isProtected?: boolean
                                                                                                                                                      mime: string
                                                                                                                                                      noteId: string
                                                                                                                                                      revisionId?: string
                                                                                                                                                      title: string
                                                                                                                                                      type:
                                                                                                                                                          | "canvas"
                                                                                                                                                          | "code"
                                                                                                                                                          | "search"
                                                                                                                                                          | "image"
                                                                                                                                                          | "text"
                                                                                                                                                          | "file"
                                                                                                                                                          | "noteMap"
                                                                                                                                                          | "launcher"
                                                                                                                                                          | "doc"
                                                                                                                                                          | "contentWidget"
                                                                                                                                                          | "relationMap"
                                                                                                                                                          | "render"
                                                                                                                                                          | "mermaid"
                                                                                                                                                          | "book"
                                                                                                                                                          | "webView"
                                                                                                                                                          | "mindMap"
                                                                                                                                                          | "geoMap"
                                                                                                                                                      utcDateCreated: string
                                                                                                                                                      utcDateLastEdited?: string
                                                                                                                                                      utcDateModified: string

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility

                                                                                                                                                      On This Page

                                                                                                                                                      Properties
                                                                                                                                                      +

                                                                                                                                                      Properties

                                                                                                                                                      blobId?: string
                                                                                                                                                      contentLength?: number
                                                                                                                                                      dateCreated: string
                                                                                                                                                      dateLastEdited?: string
                                                                                                                                                      isProtected?: boolean
                                                                                                                                                      mime: string
                                                                                                                                                      noteId: string
                                                                                                                                                      revisionId?: string
                                                                                                                                                      title: string
                                                                                                                                                      type:
                                                                                                                                                          | "canvas"
                                                                                                                                                          | "code"
                                                                                                                                                          | "search"
                                                                                                                                                          | "image"
                                                                                                                                                          | "text"
                                                                                                                                                          | "file"
                                                                                                                                                          | "noteMap"
                                                                                                                                                          | "launcher"
                                                                                                                                                          | "doc"
                                                                                                                                                          | "contentWidget"
                                                                                                                                                          | "relationMap"
                                                                                                                                                          | "render"
                                                                                                                                                          | "mermaid"
                                                                                                                                                          | "book"
                                                                                                                                                          | "webView"
                                                                                                                                                          | "mindMap"
                                                                                                                                                          | "geoMap"
                                                                                                                                                      utcDateCreated: string
                                                                                                                                                      utcDateLastEdited?: string
                                                                                                                                                      utcDateModified: string

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility

                                                                                                                                                      On This Page

                                                                                                                                                      Properties
                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.Root.html b/docs/Script API/interfaces/Backend_Script_API._internal_.Root.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.Root.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.Root.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.SavingOpts.html b/docs/Script API/interfaces/Backend_Script_API._internal_.SavingOpts.html similarity index 97% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.SavingOpts.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.SavingOpts.html index 04830e758..06acc75b5 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.SavingOpts.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.SavingOpts.html @@ -1,2 +1,2 @@ -SavingOpts | trilium
                                                                                                                                                      trilium
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Interface SavingOpts

                                                                                                                                                        interface SavingOpts {
                                                                                                                                                            skipValidation?: boolean;
                                                                                                                                                        }
                                                                                                                                                        Index

                                                                                                                                                        Properties

                                                                                                                                                        skipValidation? -

                                                                                                                                                        Properties

                                                                                                                                                        skipValidation?: boolean

                                                                                                                                                        Settings

                                                                                                                                                        Member Visibility

                                                                                                                                                        On This Page

                                                                                                                                                        Properties
                                                                                                                                                        +SavingOpts | trilium
                                                                                                                                                        trilium
                                                                                                                                                          Preparing search index...

                                                                                                                                                          Interface SavingOpts

                                                                                                                                                          interface SavingOpts {
                                                                                                                                                              skipValidation?: boolean;
                                                                                                                                                          }
                                                                                                                                                          Index

                                                                                                                                                          Properties

                                                                                                                                                          skipValidation? +

                                                                                                                                                          Properties

                                                                                                                                                          skipValidation?: boolean

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility

                                                                                                                                                          On This Page

                                                                                                                                                          Properties
                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.SearchParams.html b/docs/Script API/interfaces/Backend_Script_API._internal_.SearchParams.html similarity index 97% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.SearchParams.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.SearchParams.html index c4cb416e3..ef5ec2b0f 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.SearchParams.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.SearchParams.html @@ -1,5 +1,5 @@ SearchParams | trilium
                                                                                                                                                          trilium
                                                                                                                                                            Preparing search index...

                                                                                                                                                            Interface SearchParams

                                                                                                                                                            An instance of the frontend api available globally.

                                                                                                                                                            api

                                                                                                                                                            -
                                                                                                                                                            interface SearchParams {
                                                                                                                                                                ignoreHoistedNote?: boolean;
                                                                                                                                                                includeArchivedNotes?: boolean;
                                                                                                                                                            }
                                                                                                                                                            Index

                                                                                                                                                            Properties

                                                                                                                                                            ignoreHoistedNote? +
                                                                                                                                                            interface SearchParams {
                                                                                                                                                                ignoreHoistedNote?: boolean;
                                                                                                                                                                includeArchivedNotes?: boolean;
                                                                                                                                                            }
                                                                                                                                                            Index

                                                                                                                                                            Properties

                                                                                                                                                            ignoreHoistedNote? includeArchivedNotes? -

                                                                                                                                                            Properties

                                                                                                                                                            ignoreHoistedNote?: boolean
                                                                                                                                                            includeArchivedNotes?: boolean

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            On This Page

                                                                                                                                                            Properties
                                                                                                                                                            +

                                                                                                                                                            Properties

                                                                                                                                                            ignoreHoistedNote?: boolean
                                                                                                                                                            includeArchivedNotes?: boolean

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            On This Page

                                                                                                                                                            Properties
                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.Selector.html b/docs/Script API/interfaces/Backend_Script_API._internal_.Selector.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.Selector.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.Selector.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.SerializerOptions.html b/docs/Script API/interfaces/Backend_Script_API._internal_.SerializerOptions.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.SerializerOptions.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.SerializerOptions.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.SerializerVisitor.html b/docs/Script API/interfaces/Backend_Script_API._internal_.SerializerVisitor.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.SerializerVisitor.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.SerializerVisitor.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.StaticEventEmitterIteratorOptions.html b/docs/Script API/interfaces/Backend_Script_API._internal_.StaticEventEmitterIteratorOptions.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.StaticEventEmitterIteratorOptions.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.StaticEventEmitterIteratorOptions.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.StaticEventEmitterOptions.html b/docs/Script API/interfaces/Backend_Script_API._internal_.StaticEventEmitterOptions.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.StaticEventEmitterOptions.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.StaticEventEmitterOptions.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.TagElement.html b/docs/Script API/interfaces/Backend_Script_API._internal_.TagElement.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.TagElement.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.TagElement.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.TaskData.html b/docs/Script API/interfaces/Backend_Script_API._internal_.TaskData.html similarity index 94% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.TaskData.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.TaskData.html index 51909c782..de178f8e6 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.TaskData.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.TaskData.html @@ -1,6 +1,6 @@ -TaskData | trilium
                                                                                                                                                            trilium
                                                                                                                                                              Preparing search index...

                                                                                                                                                              Interface TaskData

                                                                                                                                                              interface TaskData {
                                                                                                                                                                  codeImportedAsCode?: boolean;
                                                                                                                                                                  replaceUnderscoresWithSpaces?: boolean;
                                                                                                                                                                  safeImport?: boolean;
                                                                                                                                                                  shrinkImages?: boolean;
                                                                                                                                                                  textImportedAsText?: boolean;
                                                                                                                                                              }
                                                                                                                                                              Index

                                                                                                                                                              Properties

                                                                                                                                                              codeImportedAsCode? +TaskData | trilium
                                                                                                                                                              trilium
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Interface TaskData

                                                                                                                                                                interface TaskData {
                                                                                                                                                                    codeImportedAsCode?: boolean;
                                                                                                                                                                    replaceUnderscoresWithSpaces?: boolean;
                                                                                                                                                                    safeImport?: boolean;
                                                                                                                                                                    shrinkImages?: boolean;
                                                                                                                                                                    textImportedAsText?: boolean;
                                                                                                                                                                }
                                                                                                                                                                Index

                                                                                                                                                                Properties

                                                                                                                                                                codeImportedAsCode? replaceUnderscoresWithSpaces? safeImport? shrinkImages? textImportedAsText? -

                                                                                                                                                                Properties

                                                                                                                                                                codeImportedAsCode?: boolean
                                                                                                                                                                replaceUnderscoresWithSpaces?: boolean
                                                                                                                                                                safeImport?: boolean
                                                                                                                                                                shrinkImages?: boolean
                                                                                                                                                                textImportedAsText?: boolean

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                On This Page

                                                                                                                                                                Properties
                                                                                                                                                                +

                                                                                                                                                                Properties

                                                                                                                                                                codeImportedAsCode?: boolean
                                                                                                                                                                replaceUnderscoresWithSpaces?: boolean
                                                                                                                                                                safeImport?: boolean
                                                                                                                                                                shrinkImages?: boolean
                                                                                                                                                                textImportedAsText?: boolean

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                On This Page

                                                                                                                                                                Properties
                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.TextElement.html b/docs/Script API/interfaces/Backend_Script_API._internal_.TextElement.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.TextElement.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.TextElement.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.TransitionalOptions.html b/docs/Script API/interfaces/Backend_Script_API._internal_.TransitionalOptions.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.TransitionalOptions.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.TransitionalOptions.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.BuilderOptions.html b/docs/Script API/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.BuilderOptions.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.BuilderOptions.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.BuilderOptions.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.ParserOptions.html b/docs/Script API/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.ParserOptions.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.ParserOptions.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.ParserOptions.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.RenderOptions.html b/docs/Script API/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.RenderOptions.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.RenderOptions.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.RenderOptions.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.XmlDeclarationAttributes.html b/docs/Script API/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.XmlDeclarationAttributes.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.XmlDeclarationAttributes.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.XmlDeclarationAttributes.html diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.convertableToString.html b/docs/Script API/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.convertableToString.html similarity index 100% rename from docs/backend_api/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.convertableToString.html rename to docs/Script API/interfaces/Backend_Script_API._internal_.node_modules__types_xml2js.convertableToString.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API.Api.html b/docs/Script API/interfaces/Frontend_Script_API.Api.html similarity index 97% rename from docs/backend_api/interfaces/Frontend_Script_API.Api.html rename to docs/Script API/interfaces/Frontend_Script_API.Api.html index 061d0dc2d..253dd56d2 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API.Api.html +++ b/docs/Script API/interfaces/Frontend_Script_API.Api.html @@ -1,4 +1,4 @@ -Api | trilium
                                                                                                                                                                trilium
                                                                                                                                                                  Preparing search index...

                                                                                                                                                                  Interface Api

                                                                                                                                                                  interface Api {
                                                                                                                                                                      $container: null | JQuery<HTMLElement>;
                                                                                                                                                                      BasicWidget: typeof default;
                                                                                                                                                                      bindGlobalShortcut: (
                                                                                                                                                                          keyboardShortcut: string,
                                                                                                                                                                          handler: null | Handler,
                                                                                                                                                                          namespace?: null | string,
                                                                                                                                                                      ) => void;
                                                                                                                                                                      createLink: (
                                                                                                                                                                          notePath: undefined | string,
                                                                                                                                                                          options?: CreateLinkOptions,
                                                                                                                                                                      ) => Promise<JQuery<HTMLElement>>;
                                                                                                                                                                      createNoteLink: (
                                                                                                                                                                          notePath: undefined | string,
                                                                                                                                                                          options?: CreateLinkOptions,
                                                                                                                                                                      ) => Promise<JQuery<HTMLElement>>;
                                                                                                                                                                      currentNote: FNote;
                                                                                                                                                                      dayjs: __module;
                                                                                                                                                                      formatDateISO: (date: Date) => string;
                                                                                                                                                                      formatNoteSize: (size: number) => string;
                                                                                                                                                                      formatSize: (size: number) => string;
                                                                                                                                                                      getDayNote: (date: string) => Promise<null | FNote>;
                                                                                                                                                                      getMonthNote: (month: string) => Promise<null | FNote>;
                                                                                                                                                                      getQuarterNote: (quarter: string) => Promise<null | FNote>;
                                                                                                                                                                      getTodayNote: () => Promise<null | FNote>;
                                                                                                                                                                      getWeekFirstDayNote: (date: string) => Promise<null | FNote>;
                                                                                                                                                                      getWeekNote: (week: string) => Promise<null | FNote>;
                                                                                                                                                                      getYearNote: (year: string) => Promise<null | FNote>;
                                                                                                                                                                      logMessages: Record<string, string[]>;
                                                                                                                                                                      logSpacedUpdates: Record<string, default>;
                                                                                                                                                                      NoteContextAwareWidget: typeof NoteContextAwareWidget;
                                                                                                                                                                      originEntity: unknown;
                                                                                                                                                                      parseDate: (str: string) => Date;
                                                                                                                                                                      protectNote: (
                                                                                                                                                                          noteId: string,
                                                                                                                                                                          protect: boolean,
                                                                                                                                                                          includingSubtree: boolean,
                                                                                                                                                                      ) => Promise<void>;
                                                                                                                                                                      protectSubTree: (
                                                                                                                                                                          noteId: string,
                                                                                                                                                                          protect: boolean,
                                                                                                                                                                          includingSubtree: boolean,
                                                                                                                                                                      ) => Promise<void>;
                                                                                                                                                                      randomString: (len: number) => string;
                                                                                                                                                                      RightPanelWidget: typeof RightPanelWidget;
                                                                                                                                                                      setupElementTooltip: ($el: JQuery<HTMLElement>) => void;
                                                                                                                                                                      showConfirmDialog: (message: string) => Promise<unknown>;
                                                                                                                                                                      showError: (message: string, delay?: number) => void;
                                                                                                                                                                      showInfoDialog: (message: string) => Promise<unknown>;
                                                                                                                                                                      showMessage: (message: string, delay?: number) => void;
                                                                                                                                                                      showPromptDialog: (props: PromptDialogOptions) => Promise<null | string>;
                                                                                                                                                                      startNote: FNote;
                                                                                                                                                                      triggerCommand: <K extends keyof CommandMappings>(
                                                                                                                                                                          name: K,
                                                                                                                                                                          _data?: CommandMappings[K],
                                                                                                                                                                      ) => undefined | null | Promise<unknown>;
                                                                                                                                                                      triggerEvent: <K extends EventNames>(
                                                                                                                                                                          name: K,
                                                                                                                                                                          data: EventData<K>,
                                                                                                                                                                      ) => undefined | null | Promise<unknown>;
                                                                                                                                                                      waitUntilSynced: () => Promise<void>;
                                                                                                                                                                      activateNewNote(notePath: string): Promise<void>;
                                                                                                                                                                      activateNote(notePath: string): Promise<void>;
                                                                                                                                                                      addButtonToToolbar(opts: AddToToolbarOpts): void;
                                                                                                                                                                      addTextToActiveContextEditor(text: string): void;
                                                                                                                                                                      getActiveContext(): NoteContext;
                                                                                                                                                                      getActiveContextCodeEditor(): Promise<unknown>;
                                                                                                                                                                      getActiveContextNote(): FNote;
                                                                                                                                                                      getActiveContextNotePath(): null | string;
                                                                                                                                                                      getActiveContextTextEditor(): Promise<unknown>;
                                                                                                                                                                      getActiveMainContext(): NoteContext;
                                                                                                                                                                      getActiveNoteDetailWidget(): Promise<default>;
                                                                                                                                                                      getComponentByEl(el: HTMLElement): default;
                                                                                                                                                                      getInstanceName(): string;
                                                                                                                                                                      getMainNoteContexts(): NoteContext[];
                                                                                                                                                                      getNote(noteId: string): Promise<null | FNote>;
                                                                                                                                                                      getNoteContexts(): NoteContext[];
                                                                                                                                                                      getNotes(
                                                                                                                                                                          noteIds: string[],
                                                                                                                                                                          silentNotFoundError?: boolean,
                                                                                                                                                                      ): Promise<FNote[]>;
                                                                                                                                                                      log(message: string): void;
                                                                                                                                                                      openSplitWithNote(notePath: string, activate: boolean): Promise<void>;
                                                                                                                                                                      openTabWithNote(notePath: string, activate: boolean): Promise<void>;
                                                                                                                                                                      refreshIncludedNote(includedNoteId: string): void;
                                                                                                                                                                      reloadNotes(noteIds: string[]): Promise<void>;
                                                                                                                                                                      runAsyncOnBackendWithManualTransactionHandling(
                                                                                                                                                                          func: Func,
                                                                                                                                                                          params: unknown[],
                                                                                                                                                                      ): unknown;
                                                                                                                                                                      runOnBackend(func: Func, params: unknown[]): unknown;
                                                                                                                                                                      searchForNote(searchString: string): Promise<null | FNote>;
                                                                                                                                                                      searchForNotes(searchString: string): Promise<FNote[]>;
                                                                                                                                                                      setHoistedNoteId(noteId: string): void;
                                                                                                                                                                  }
                                                                                                                                                                  Index

                                                                                                                                                                  Properties

                                                                                                                                                                  $container +Api | trilium
                                                                                                                                                                  trilium
                                                                                                                                                                    Preparing search index...

                                                                                                                                                                    Interface Api

                                                                                                                                                                    interface Api {
                                                                                                                                                                        $container: null | JQuery<HTMLElement>;
                                                                                                                                                                        BasicWidget: typeof default;
                                                                                                                                                                        bindGlobalShortcut: (
                                                                                                                                                                            keyboardShortcut: string,
                                                                                                                                                                            handler: null | Handler,
                                                                                                                                                                            namespace?: null | string,
                                                                                                                                                                        ) => void;
                                                                                                                                                                        createLink: (
                                                                                                                                                                            notePath: undefined | string,
                                                                                                                                                                            options?: CreateLinkOptions,
                                                                                                                                                                        ) => Promise<JQuery<HTMLElement>>;
                                                                                                                                                                        createNoteLink: (
                                                                                                                                                                            notePath: undefined | string,
                                                                                                                                                                            options?: CreateLinkOptions,
                                                                                                                                                                        ) => Promise<JQuery<HTMLElement>>;
                                                                                                                                                                        currentNote: FNote;
                                                                                                                                                                        dayjs: __module;
                                                                                                                                                                        formatDateISO: (date: Date) => string;
                                                                                                                                                                        formatNoteSize: (size: number) => string;
                                                                                                                                                                        formatSize: (size: number) => string;
                                                                                                                                                                        getDayNote: (date: string) => Promise<null | FNote>;
                                                                                                                                                                        getMonthNote: (month: string) => Promise<null | FNote>;
                                                                                                                                                                        getQuarterNote: (quarter: string) => Promise<null | FNote>;
                                                                                                                                                                        getTodayNote: () => Promise<null | FNote>;
                                                                                                                                                                        getWeekFirstDayNote: (date: string) => Promise<null | FNote>;
                                                                                                                                                                        getWeekNote: (week: string) => Promise<null | FNote>;
                                                                                                                                                                        getYearNote: (year: string) => Promise<null | FNote>;
                                                                                                                                                                        logMessages: Record<string, string[]>;
                                                                                                                                                                        logSpacedUpdates: Record<string, default>;
                                                                                                                                                                        NoteContextAwareWidget: typeof NoteContextAwareWidget;
                                                                                                                                                                        originEntity: unknown;
                                                                                                                                                                        parseDate: (str: string) => Date;
                                                                                                                                                                        protectNote: (
                                                                                                                                                                            noteId: string,
                                                                                                                                                                            protect: boolean,
                                                                                                                                                                            includingSubtree: boolean,
                                                                                                                                                                        ) => Promise<void>;
                                                                                                                                                                        protectSubTree: (
                                                                                                                                                                            noteId: string,
                                                                                                                                                                            protect: boolean,
                                                                                                                                                                            includingSubtree: boolean,
                                                                                                                                                                        ) => Promise<void>;
                                                                                                                                                                        randomString: (len: number) => string;
                                                                                                                                                                        RightPanelWidget: typeof RightPanelWidget;
                                                                                                                                                                        setupElementTooltip: ($el: JQuery<HTMLElement>) => void;
                                                                                                                                                                        showConfirmDialog: (message: string) => Promise<unknown>;
                                                                                                                                                                        showError: (message: string, delay?: number) => void;
                                                                                                                                                                        showInfoDialog: (message: string) => Promise<unknown>;
                                                                                                                                                                        showMessage: (message: string, delay?: number) => void;
                                                                                                                                                                        showPromptDialog: (props: PromptDialogOptions) => Promise<null | string>;
                                                                                                                                                                        startNote: FNote;
                                                                                                                                                                        triggerCommand: <K extends keyof CommandMappings>(
                                                                                                                                                                            name: K,
                                                                                                                                                                            _data?: CommandMappings[K],
                                                                                                                                                                        ) => undefined | null | Promise<unknown>;
                                                                                                                                                                        triggerEvent: <K extends EventNames>(
                                                                                                                                                                            name: K,
                                                                                                                                                                            data: EventData<K>,
                                                                                                                                                                        ) => undefined | null | Promise<unknown>;
                                                                                                                                                                        waitUntilSynced: () => Promise<void>;
                                                                                                                                                                        activateNewNote(notePath: string): Promise<void>;
                                                                                                                                                                        activateNote(notePath: string): Promise<void>;
                                                                                                                                                                        addButtonToToolbar(opts: AddToToolbarOpts): void;
                                                                                                                                                                        addTextToActiveContextEditor(text: string): void;
                                                                                                                                                                        getActiveContext(): NoteContext;
                                                                                                                                                                        getActiveContextCodeEditor(): Promise<unknown>;
                                                                                                                                                                        getActiveContextNote(): FNote;
                                                                                                                                                                        getActiveContextNotePath(): null | string;
                                                                                                                                                                        getActiveContextTextEditor(): Promise<unknown>;
                                                                                                                                                                        getActiveMainContext(): NoteContext;
                                                                                                                                                                        getActiveNoteDetailWidget(): Promise<default>;
                                                                                                                                                                        getComponentByEl(el: HTMLElement): default;
                                                                                                                                                                        getInstanceName(): string;
                                                                                                                                                                        getMainNoteContexts(): NoteContext[];
                                                                                                                                                                        getNote(noteId: string): Promise<null | FNote>;
                                                                                                                                                                        getNoteContexts(): NoteContext[];
                                                                                                                                                                        getNotes(
                                                                                                                                                                            noteIds: string[],
                                                                                                                                                                            silentNotFoundError?: boolean,
                                                                                                                                                                        ): Promise<FNote[]>;
                                                                                                                                                                        log(message: string): void;
                                                                                                                                                                        openSplitWithNote(notePath: string, activate: boolean): Promise<void>;
                                                                                                                                                                        openTabWithNote(notePath: string, activate: boolean): Promise<void>;
                                                                                                                                                                        refreshIncludedNote(includedNoteId: string): void;
                                                                                                                                                                        reloadNotes(noteIds: string[]): Promise<void>;
                                                                                                                                                                        runAsyncOnBackendWithManualTransactionHandling(
                                                                                                                                                                            func: Func,
                                                                                                                                                                            params: unknown[],
                                                                                                                                                                        ): unknown;
                                                                                                                                                                        runOnBackend(func: Func, params: unknown[]): unknown;
                                                                                                                                                                        searchForNote(searchString: string): Promise<null | FNote>;
                                                                                                                                                                        searchForNotes(searchString: string): Promise<FNote[]>;
                                                                                                                                                                        setHoistedNoteId(noteId: string): void;
                                                                                                                                                                    }
                                                                                                                                                                    Index

                                                                                                                                                                    Properties

                                                                                                                                                                    $container BasicWidget bindGlobalShortcut createLink @@ -62,102 +62,102 @@ searchForNotes setHoistedNoteId

                                                                                                                                                                    Properties

                                                                                                                                                                    $container: null | JQuery<HTMLElement>

                                                                                                                                                                    Container of all the rendered script content

                                                                                                                                                                    -
                                                                                                                                                                    BasicWidget: typeof default
                                                                                                                                                                    bindGlobalShortcut: (
                                                                                                                                                                        keyboardShortcut: string,
                                                                                                                                                                        handler: null | Handler,
                                                                                                                                                                        namespace?: null | string,
                                                                                                                                                                    ) => void

                                                                                                                                                                    Type declaration

                                                                                                                                                                    BasicWidget: typeof default
                                                                                                                                                                    bindGlobalShortcut: (
                                                                                                                                                                        keyboardShortcut: string,
                                                                                                                                                                        handler: null | Handler,
                                                                                                                                                                        namespace?: null | string,
                                                                                                                                                                    ) => void

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (
                                                                                                                                                                            keyboardShortcut: string,
                                                                                                                                                                            handler: null | Handler,
                                                                                                                                                                            namespace?: null | string,
                                                                                                                                                                        ): void

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • keyboardShortcut: string

                                                                                                                                                                          e.g. "ctrl+shift+a"

                                                                                                                                                                        • handler: null | Handler
                                                                                                                                                                        • namespace: null | string = null

                                                                                                                                                                          specify namespace of the handler for the cases where call for bind may be repeated. If a handler with this ID exists, it's replaced by the new handler.

                                                                                                                                                                          -

                                                                                                                                                                        Returns void

                                                                                                                                                                    createLink: (
                                                                                                                                                                        notePath: undefined | string,
                                                                                                                                                                        options?: CreateLinkOptions,
                                                                                                                                                                    ) => Promise<JQuery<HTMLElement>>

                                                                                                                                                                    Create a note link (jQuery object) for given note.

                                                                                                                                                                    +

                                                                                                                                                                    Returns void

                                                                                                                                                                    createLink: (
                                                                                                                                                                        notePath: undefined | string,
                                                                                                                                                                        options?: CreateLinkOptions,
                                                                                                                                                                    ) => Promise<JQuery<HTMLElement>>

                                                                                                                                                                    Create a note link (jQuery object) for given note.

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (
                                                                                                                                                                            notePath: undefined | string,
                                                                                                                                                                            options?: CreateLinkOptions,
                                                                                                                                                                        ): Promise<JQuery<HTMLElement>>

                                                                                                                                                                      • Parameters

                                                                                                                                                                        Returns Promise<JQuery<HTMLElement>>

                                                                                                                                                                        • jQuery element with the link (wrapped in )
                                                                                                                                                                        -
                                                                                                                                                                    createNoteLink: (
                                                                                                                                                                        notePath: undefined | string,
                                                                                                                                                                        options?: CreateLinkOptions,
                                                                                                                                                                    ) => Promise<JQuery<HTMLElement>>
                                                                                                                                                                      +
                                                                                                                                                                    createNoteLink: (
                                                                                                                                                                        notePath: undefined | string,
                                                                                                                                                                        options?: CreateLinkOptions,
                                                                                                                                                                    ) => Promise<JQuery<HTMLElement>>
                                                                                                                                                                    • use api.createLink() instead
                                                                                                                                                                    -
                                                                                                                                                                    currentNote: FNote

                                                                                                                                                                    Note where the script is currently executing, i.e. the note where the currently executing source code is written.

                                                                                                                                                                    -
                                                                                                                                                                    dayjs: __module

                                                                                                                                                                    day.js library for date manipulation. +

                                                                                                                                                                    currentNote: FNote

                                                                                                                                                                    Note where the script is currently executing, i.e. the note where the currently executing source code is written.

                                                                                                                                                                    +
                                                                                                                                                                    dayjs: __module

                                                                                                                                                                    day.js library for date manipulation. See https://day.js.org for documentation

                                                                                                                                                                    https://day.js.org

                                                                                                                                                                    -
                                                                                                                                                                    formatDateISO: (date: Date) => string

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (date: Date): string

                                                                                                                                                                      • this is producing local time! *

                                                                                                                                                                        +
                                                                                                                                                                    formatDateISO: (date: Date) => string

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (date: Date): string

                                                                                                                                                                      • this is producing local time! *

                                                                                                                                                                        Parameters

                                                                                                                                                                        • date: Date

                                                                                                                                                                        Returns string

                                                                                                                                                                    date in YYYY-MM-DD format

                                                                                                                                                                    -
                                                                                                                                                                    formatNoteSize: (size: number) => string

                                                                                                                                                                    Type declaration

                                                                                                                                                                    formatNoteSize: (size: number) => string

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (size: number): string

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • size: number

                                                                                                                                                                          in bytes

                                                                                                                                                                        Returns string

                                                                                                                                                                        formatted string

                                                                                                                                                                    • use api.formatSize()
                                                                                                                                                                    -
                                                                                                                                                                    formatSize: (size: number) => string

                                                                                                                                                                    Type declaration

                                                                                                                                                                    formatSize: (size: number) => string

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (size: number): string

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • size: number

                                                                                                                                                                          in bytes

                                                                                                                                                                        Returns string

                                                                                                                                                                        formatted string

                                                                                                                                                                        -
                                                                                                                                                                    getDayNote: (date: string) => Promise<null | FNote>

                                                                                                                                                                    Returns day note for a given date. If it doesn't exist, it is automatically created.

                                                                                                                                                                    +
                                                                                                                                                                    getDayNote: (date: string) => Promise<null | FNote>

                                                                                                                                                                    Returns day note for a given date. If it doesn't exist, it is automatically created.

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (date: string): Promise<null | FNote>

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • date: string

                                                                                                                                                                          e.g. "2019-04-29"

                                                                                                                                                                          -

                                                                                                                                                                        Returns Promise<null | FNote>

                                                                                                                                                                    getMonthNote: (month: string) => Promise<null | FNote>

                                                                                                                                                                    Returns month-note. If it doesn't exist, it is automatically created.

                                                                                                                                                                    +

                                                                                                                                                                    Returns Promise<null | FNote>

                                                                                                                                                                    getMonthNote: (month: string) => Promise<null | FNote>

                                                                                                                                                                    Returns month-note. If it doesn't exist, it is automatically created.

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (month: string): Promise<null | FNote>

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • month: string

                                                                                                                                                                          e.g. "2019-04"

                                                                                                                                                                          -

                                                                                                                                                                        Returns Promise<null | FNote>

                                                                                                                                                                    getQuarterNote: (quarter: string) => Promise<null | FNote>

                                                                                                                                                                    Returns quarter note for given date. If such a note doesn't exist, it is automatically created.

                                                                                                                                                                    -
                                                                                                                                                                    getTodayNote: () => Promise<null | FNote>

                                                                                                                                                                    Returns date-note for today. If it doesn't exist, it is automatically created.

                                                                                                                                                                    -
                                                                                                                                                                    getWeekFirstDayNote: (date: string) => Promise<null | FNote>

                                                                                                                                                                    Returns day note for the first date of the week of the given date. If it doesn't exist, it is automatically created.

                                                                                                                                                                    +

                                                                                                                                                                    Returns Promise<null | FNote>

                                                                                                                                                                    getQuarterNote: (quarter: string) => Promise<null | FNote>

                                                                                                                                                                    Returns quarter note for given date. If such a note doesn't exist, it is automatically created.

                                                                                                                                                                    +
                                                                                                                                                                    getTodayNote: () => Promise<null | FNote>

                                                                                                                                                                    Returns date-note for today. If it doesn't exist, it is automatically created.

                                                                                                                                                                    +
                                                                                                                                                                    getWeekFirstDayNote: (date: string) => Promise<null | FNote>

                                                                                                                                                                    Returns day note for the first date of the week of the given date. If it doesn't exist, it is automatically created.

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (date: string): Promise<null | FNote>

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • date: string

                                                                                                                                                                          e.g. "2019-04-29"

                                                                                                                                                                          -

                                                                                                                                                                        Returns Promise<null | FNote>

                                                                                                                                                                    getWeekNote: (week: string) => Promise<null | FNote>

                                                                                                                                                                    Returns week note for given date. If such a note doesn't exist, it is automatically created.

                                                                                                                                                                    -
                                                                                                                                                                    getYearNote: (year: string) => Promise<null | FNote>

                                                                                                                                                                    Returns year-note. If it doesn't exist, it is automatically created.

                                                                                                                                                                    +

                                                                                                                                                                    Returns Promise<null | FNote>

                                                                                                                                                                    getWeekNote: (week: string) => Promise<null | FNote>

                                                                                                                                                                    Returns week note for given date. If such a note doesn't exist, it is automatically created.

                                                                                                                                                                    +
                                                                                                                                                                    getYearNote: (year: string) => Promise<null | FNote>

                                                                                                                                                                    Returns year-note. If it doesn't exist, it is automatically created.

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (year: string): Promise<null | FNote>

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • year: string

                                                                                                                                                                          e.g. "2019"

                                                                                                                                                                          -

                                                                                                                                                                        Returns Promise<null | FNote>

                                                                                                                                                                    logMessages: Record<string, string[]>
                                                                                                                                                                    logSpacedUpdates: Record<string, default>
                                                                                                                                                                    NoteContextAwareWidget: typeof NoteContextAwareWidget
                                                                                                                                                                    originEntity: unknown

                                                                                                                                                                    Entity whose event triggered this execution.

                                                                                                                                                                    -
                                                                                                                                                                    parseDate: (str: string) => Date
                                                                                                                                                                    protectNote: (
                                                                                                                                                                        noteId: string,
                                                                                                                                                                        protect: boolean,
                                                                                                                                                                        includingSubtree: boolean,
                                                                                                                                                                    ) => Promise<void>

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (noteId: string, protect: boolean, includingSubtree: boolean): Promise<void>

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • noteId: string
                                                                                                                                                                        • protect: boolean

                                                                                                                                                                          true to protect note, false to unprotect

                                                                                                                                                                          -
                                                                                                                                                                        • includingSubtree: boolean

                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                    protectSubTree: (
                                                                                                                                                                        noteId: string,
                                                                                                                                                                        protect: boolean,
                                                                                                                                                                        includingSubtree: boolean,
                                                                                                                                                                    ) => Promise<void>

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (noteId: string, protect: boolean, includingSubtree: boolean): Promise<void>

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • noteId: string
                                                                                                                                                                        • protect: boolean

                                                                                                                                                                          true to protect subtree, false to unprotect

                                                                                                                                                                          -
                                                                                                                                                                        • includingSubtree: boolean

                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                    randomString: (len: number) => string

                                                                                                                                                                    Return randomly generated string of given length. This random string generation is NOT cryptographically secure.

                                                                                                                                                                    +

                                                                                                                                                                    Returns Promise<null | FNote>

                                                                                                                                                                    logMessages: Record<string, string[]>
                                                                                                                                                                    logSpacedUpdates: Record<string, default>
                                                                                                                                                                    NoteContextAwareWidget: typeof NoteContextAwareWidget
                                                                                                                                                                    originEntity: unknown

                                                                                                                                                                    Entity whose event triggered this execution.

                                                                                                                                                                    +
                                                                                                                                                                    parseDate: (str: string) => Date
                                                                                                                                                                    protectNote: (
                                                                                                                                                                        noteId: string,
                                                                                                                                                                        protect: boolean,
                                                                                                                                                                        includingSubtree: boolean,
                                                                                                                                                                    ) => Promise<void>

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (noteId: string, protect: boolean, includingSubtree: boolean): Promise<void>

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • noteId: string
                                                                                                                                                                        • protect: boolean

                                                                                                                                                                          true to protect note, false to unprotect

                                                                                                                                                                          +
                                                                                                                                                                        • includingSubtree: boolean

                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                    protectSubTree: (
                                                                                                                                                                        noteId: string,
                                                                                                                                                                        protect: boolean,
                                                                                                                                                                        includingSubtree: boolean,
                                                                                                                                                                    ) => Promise<void>

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (noteId: string, protect: boolean, includingSubtree: boolean): Promise<void>

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • noteId: string
                                                                                                                                                                        • protect: boolean

                                                                                                                                                                          true to protect subtree, false to unprotect

                                                                                                                                                                          +
                                                                                                                                                                        • includingSubtree: boolean

                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                    randomString: (len: number) => string

                                                                                                                                                                    Return randomly generated string of given length. This random string generation is NOT cryptographically secure.

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (len: number): string

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • len: number

                                                                                                                                                                        Returns string

                                                                                                                                                                        random string

                                                                                                                                                                        -
                                                                                                                                                                    RightPanelWidget: typeof RightPanelWidget
                                                                                                                                                                    setupElementTooltip: ($el: JQuery<HTMLElement>) => void

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • ($el: JQuery<HTMLElement>): void

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • $el: JQuery<HTMLElement>

                                                                                                                                                                          jquery object on which to set up the tooltip

                                                                                                                                                                          -

                                                                                                                                                                        Returns void

                                                                                                                                                                    showConfirmDialog: (message: string) => Promise<unknown>

                                                                                                                                                                    Show confirm dialog to the user.

                                                                                                                                                                    +
                                                                                                                                                                    RightPanelWidget: typeof RightPanelWidget
                                                                                                                                                                    setupElementTooltip: ($el: JQuery<HTMLElement>) => void

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • ($el: JQuery<HTMLElement>): void

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • $el: JQuery<HTMLElement>

                                                                                                                                                                          jquery object on which to set up the tooltip

                                                                                                                                                                          +

                                                                                                                                                                        Returns void

                                                                                                                                                                    showConfirmDialog: (message: string) => Promise<unknown>

                                                                                                                                                                    Show confirm dialog to the user.

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (message: string): Promise<unknown>

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • message: string

                                                                                                                                                                        Returns Promise<unknown>

                                                                                                                                                                        promise resolving to true if the user confirmed

                                                                                                                                                                        -
                                                                                                                                                                    showError: (message: string, delay?: number) => void

                                                                                                                                                                    Show an error toast message to the user.

                                                                                                                                                                    -
                                                                                                                                                                    showInfoDialog: (message: string) => Promise<unknown>

                                                                                                                                                                    Show an info dialog to the user.

                                                                                                                                                                    -
                                                                                                                                                                    showMessage: (message: string, delay?: number) => void

                                                                                                                                                                    Show an info toast message to the user.

                                                                                                                                                                    -
                                                                                                                                                                    showPromptDialog: (props: PromptDialogOptions) => Promise<null | string>

                                                                                                                                                                    Show prompt dialog to the user.

                                                                                                                                                                    +
                                                                                                                                                                    showError: (message: string, delay?: number) => void

                                                                                                                                                                    Show an error toast message to the user.

                                                                                                                                                                    +
                                                                                                                                                                    showInfoDialog: (message: string) => Promise<unknown>

                                                                                                                                                                    Show an info dialog to the user.

                                                                                                                                                                    +
                                                                                                                                                                    showMessage: (message: string, delay?: number) => void

                                                                                                                                                                    Show an info toast message to the user.

                                                                                                                                                                    +
                                                                                                                                                                    showPromptDialog: (props: PromptDialogOptions) => Promise<null | string>

                                                                                                                                                                    Show prompt dialog to the user.

                                                                                                                                                                    Type declaration

                                                                                                                                                                    startNote: FNote

                                                                                                                                                                    Note where the script started executing, i.e., the (event) entrypoint of the current script execution.

                                                                                                                                                                    -
                                                                                                                                                                    triggerCommand: <K extends keyof CommandMappings>(
                                                                                                                                                                        name: K,
                                                                                                                                                                        _data?: CommandMappings[K],
                                                                                                                                                                    ) => undefined | null | Promise<unknown>

                                                                                                                                                                    Trigger command. This is a very low-level API which should be avoided if possible.

                                                                                                                                                                    -
                                                                                                                                                                    triggerEvent: <K extends EventNames>(
                                                                                                                                                                        name: K,
                                                                                                                                                                        data: EventData<K>,
                                                                                                                                                                    ) => undefined | null | Promise<unknown>

                                                                                                                                                                    Trigger event. This is a very low-level API which should be avoided if possible.

                                                                                                                                                                    -
                                                                                                                                                                    waitUntilSynced: () => Promise<void>

                                                                                                                                                                    Trilium runs in a backend and frontend process, when something is changed on the backend from a script, +

                                                                                                                                                                    startNote: FNote

                                                                                                                                                                    Note where the script started executing, i.e., the (event) entrypoint of the current script execution.

                                                                                                                                                                    +
                                                                                                                                                                    triggerCommand: <K extends keyof CommandMappings>(
                                                                                                                                                                        name: K,
                                                                                                                                                                        _data?: CommandMappings[K],
                                                                                                                                                                    ) => undefined | null | Promise<unknown>

                                                                                                                                                                    Trigger command. This is a very low-level API which should be avoided if possible.

                                                                                                                                                                    +
                                                                                                                                                                    triggerEvent: <K extends EventNames>(
                                                                                                                                                                        name: K,
                                                                                                                                                                        data: EventData<K>,
                                                                                                                                                                    ) => undefined | null | Promise<unknown>

                                                                                                                                                                    Trigger event. This is a very low-level API which should be avoided if possible.

                                                                                                                                                                    +
                                                                                                                                                                    waitUntilSynced: () => Promise<void>

                                                                                                                                                                    Trilium runs in a backend and frontend process, when something is changed on the backend from a script, frontend will get asynchronously synchronized.

                                                                                                                                                                    This method returns a promise which resolves once all the backend -> frontend synchronization is finished. Typical use case is when a new note has been created, we should wait until it is synced into frontend and only then activate it.

                                                                                                                                                                    -

                                                                                                                                                                    Methods

                                                                                                                                                                    Methods

                                                                                                                                                                    • Activates newly created note. Compared to this.activateNote() also makes sure that frontend has been fully synced.

                                                                                                                                                                      Parameters

                                                                                                                                                                      • notePath: string

                                                                                                                                                                        (or noteId)

                                                                                                                                                                        -

                                                                                                                                                                      Returns Promise<void>

                                                                                                                                                                    • Activates note in the tree and in the note detail.

                                                                                                                                                                      +

                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                    • Adds a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.

                                                                                                                                                                      +

                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                    • Adds a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.

                                                                                                                                                                      Parameters

                                                                                                                                                                      Returns void

                                                                                                                                                                      you can now create/modify launchers in the top-left Menu -> Configure Launchbar for special needs there's also backend API's createOrUpdateLauncher()

                                                                                                                                                                      -

                                                                                                                                                                    Returns void

                                                                                                                                                                    • Instance name identifies particular Trilium instance. It can be useful for scripts +

                                                                                                                                                                    Returns default

                                                                                                                                                                    • Returns list of notes. If note is missing from the cache, it's loaded.

                                                                                                                                                                      This is often used to bulk-fill the cache with notes which would have to be picked one by one otherwise (by e.g. createLink())

                                                                                                                                                                      Parameters

                                                                                                                                                                      • noteIds: string[]
                                                                                                                                                                      • OptionalsilentNotFoundError: boolean

                                                                                                                                                                        don't report error if the note is not found

                                                                                                                                                                        -

                                                                                                                                                                      Returns Promise<FNote[]>

                                                                                                                                                                    • Open a note in a new split.

                                                                                                                                                                      +

                                                                                                                                                                    Returns Promise<FNote[]>

                                                                                                                                                                    • Open a note in a new split.

                                                                                                                                                                      Parameters

                                                                                                                                                                      • notePath: string

                                                                                                                                                                        (or noteId)

                                                                                                                                                                      • activate: boolean

                                                                                                                                                                        set to true to activate the new split, false to stay on the current split

                                                                                                                                                                        -

                                                                                                                                                                      Returns Promise<void>

                                                                                                                                                                    • Open a note in a new tab.

                                                                                                                                                                      +

                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                    • Open a note in a new tab.

                                                                                                                                                                      Parameters

                                                                                                                                                                      • notePath: string

                                                                                                                                                                        (or noteId)

                                                                                                                                                                      • activate: boolean

                                                                                                                                                                        set to true to activate the new tab, false to stay on the current tab

                                                                                                                                                                        -

                                                                                                                                                                      Returns Promise<void>

                                                                                                                                                                    • This will refresh all currently opened notes which have included note specified in the parameter

                                                                                                                                                                      +

                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                    • This will refresh all currently opened notes which have included note specified in the parameter

                                                                                                                                                                      Parameters

                                                                                                                                                                      • includedNoteId: string

                                                                                                                                                                        noteId of the included note

                                                                                                                                                                        -

                                                                                                                                                                      Returns void

                                                                                                                                                                    • Executes given anonymous function on the backend. +

                                                                                                                                                                    Returns void

                                                                                                                                                                    • Executes given anonymous function on the backend. Internally this serializes the anonymous function into string and sends it to backend via AJAX. This function is meant for advanced needs where an async function is necessary. In this case, the automatic request-scoped transaction management is not applied, @@ -166,17 +166,17 @@ and you need to manually define transaction via api.transactional().

                                                                                                                                                                      Parameters

                                                                                                                                                                      • func: Func

                                                                                                                                                                        (synchronous) function to be executed on the backend

                                                                                                                                                                      • params: unknown[]

                                                                                                                                                                        list of parameters to the anonymous function to be sent to backend

                                                                                                                                                                      Returns unknown

                                                                                                                                                                      return value of the executed function on the backend

                                                                                                                                                                      -

                                                                                                                                                                    • Executes given anonymous function on the backend. Internally this serializes the anonymous function into string and sends it to backend via AJAX. Please make sure that the supplied function is synchronous. Only sync functions will work correctly with transaction management. If you really know what you're doing, you can call api.runAsyncOnBackendWithManualTransactionHandling()

                                                                                                                                                                      Parameters

                                                                                                                                                                      • func: Func

                                                                                                                                                                        (synchronous) function to be executed on the backend

                                                                                                                                                                      • params: unknown[]

                                                                                                                                                                        list of parameters to the anonymous function to be sent to backend

                                                                                                                                                                      Returns unknown

                                                                                                                                                                      return value of the executed function on the backend

                                                                                                                                                                      -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    On This Page

                                                                                                                                                                    Properties
                                                                                                                                                                    Methods
                                                                                                                                                                    +

                                                                                                                                                                    Returns void

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    On This Page

                                                                                                                                                                    Properties
                                                                                                                                                                    Methods
                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.AddToToolbarOpts.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.AddToToolbarOpts.html similarity index 97% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.AddToToolbarOpts.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.AddToToolbarOpts.html index 886e70a90..c2d1601a1 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.AddToToolbarOpts.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.AddToToolbarOpts.html @@ -1,13 +1,13 @@ AddToToolbarOpts | trilium
                                                                                                                                                                    trilium
                                                                                                                                                                      Preparing search index...

                                                                                                                                                                      Interface AddToToolbarOpts

                                                                                                                                                                      An instance of the frontend api available globally.

                                                                                                                                                                      api

                                                                                                                                                                      -
                                                                                                                                                                      interface AddToToolbarOpts {
                                                                                                                                                                          action: () => void;
                                                                                                                                                                          icon: string;
                                                                                                                                                                          id: string;
                                                                                                                                                                          shortcut: string;
                                                                                                                                                                          title: string;
                                                                                                                                                                      }
                                                                                                                                                                      Index

                                                                                                                                                                      Properties

                                                                                                                                                                      action +
                                                                                                                                                                      interface AddToToolbarOpts {
                                                                                                                                                                          action: () => void;
                                                                                                                                                                          icon: string;
                                                                                                                                                                          id: string;
                                                                                                                                                                          shortcut: string;
                                                                                                                                                                          title: string;
                                                                                                                                                                      }
                                                                                                                                                                      Index

                                                                                                                                                                      Properties

                                                                                                                                                                      action icon id shortcut title

                                                                                                                                                                      Properties

                                                                                                                                                                      action: () => void

                                                                                                                                                                      callback handling the click on the button

                                                                                                                                                                      -
                                                                                                                                                                      icon: string

                                                                                                                                                                      name of the boxicon to be used (e.g. "time" for "bx-time" icon)

                                                                                                                                                                      -
                                                                                                                                                                      id: string

                                                                                                                                                                      id of the button, used to identify the old instances of this button to be replaced +

                                                                                                                                                                      icon: string

                                                                                                                                                                      name of the boxicon to be used (e.g. "time" for "bx-time" icon)

                                                                                                                                                                      +
                                                                                                                                                                      id: string

                                                                                                                                                                      id of the button, used to identify the old instances of this button to be replaced ID is optional because of BC, but not specifying it is deprecated. ID can be alphanumeric only.

                                                                                                                                                                      -
                                                                                                                                                                      shortcut: string

                                                                                                                                                                      keyboard shortcut for the button, e.g. "alt+t"

                                                                                                                                                                      -
                                                                                                                                                                      title: string

                                                                                                                                                                      Settings

                                                                                                                                                                      Member Visibility

                                                                                                                                                                      On This Page

                                                                                                                                                                      Properties
                                                                                                                                                                      +
                                                                                                                                                                      shortcut: string

                                                                                                                                                                      keyboard shortcut for the button, e.g. "alt+t"

                                                                                                                                                                      +
                                                                                                                                                                      title: string

                                                                                                                                                                      Settings

                                                                                                                                                                      Member Visibility

                                                                                                                                                                      On This Page

                                                                                                                                                                      Properties
                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Attribute.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Attribute.html similarity index 94% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.Attribute.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.Attribute.html index c68d5697a..1836b676c 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Attribute.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.Attribute.html @@ -1,4 +1,4 @@ -Attribute | trilium
                                                                                                                                                                      trilium
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Interface Attribute

                                                                                                                                                                        interface Attribute {
                                                                                                                                                                            attributeId?: string;
                                                                                                                                                                            endIndex?: number;
                                                                                                                                                                            isInheritable?: boolean;
                                                                                                                                                                            name: string;
                                                                                                                                                                            noteId?: string;
                                                                                                                                                                            startIndex?: number;
                                                                                                                                                                            type: AttributeType;
                                                                                                                                                                            value?: string;
                                                                                                                                                                        }
                                                                                                                                                                        Index

                                                                                                                                                                        Properties

                                                                                                                                                                        attributeId? +Attribute | trilium
                                                                                                                                                                        trilium
                                                                                                                                                                          Preparing search index...

                                                                                                                                                                          Interface Attribute

                                                                                                                                                                          interface Attribute {
                                                                                                                                                                              attributeId?: string;
                                                                                                                                                                              endIndex?: number;
                                                                                                                                                                              isInheritable?: boolean;
                                                                                                                                                                              name: string;
                                                                                                                                                                              noteId?: string;
                                                                                                                                                                              startIndex?: number;
                                                                                                                                                                              type: AttributeType;
                                                                                                                                                                              value?: string;
                                                                                                                                                                          }
                                                                                                                                                                          Index

                                                                                                                                                                          Properties

                                                                                                                                                                          attributeId? endIndex? isInheritable? name @@ -6,4 +6,4 @@ startIndex? type value? -

                                                                                                                                                                          Properties

                                                                                                                                                                          attributeId?: string
                                                                                                                                                                          endIndex?: number
                                                                                                                                                                          isInheritable?: boolean
                                                                                                                                                                          name: string
                                                                                                                                                                          noteId?: string
                                                                                                                                                                          startIndex?: number
                                                                                                                                                                          type: AttributeType
                                                                                                                                                                          value?: string

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          On This Page

                                                                                                                                                                          Properties
                                                                                                                                                                          +

                                                                                                                                                                          Properties

                                                                                                                                                                          attributeId?: string
                                                                                                                                                                          endIndex?: number
                                                                                                                                                                          isInheritable?: boolean
                                                                                                                                                                          name: string
                                                                                                                                                                          noteId?: string
                                                                                                                                                                          startIndex?: number
                                                                                                                                                                          type: AttributeType
                                                                                                                                                                          value?: string

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          On This Page

                                                                                                                                                                          Properties
                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.BaseJQueryEventObject.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.BaseJQueryEventObject.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.BaseJQueryEventObject.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.BaseJQueryEventObject.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CKEvent.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.CKEvent.html similarity index 98% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.CKEvent.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.CKEvent.html index 72456749a..da1b7f798 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CKEvent.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.CKEvent.html @@ -1,2 +1,2 @@ -CKEvent | trilium
                                                                                                                                                                          trilium
                                                                                                                                                                            Preparing search index...

                                                                                                                                                                            Interface CKEvent

                                                                                                                                                                            interface CKEvent {
                                                                                                                                                                                stop(): void;
                                                                                                                                                                            }
                                                                                                                                                                            Index

                                                                                                                                                                            Methods

                                                                                                                                                                            stop -

                                                                                                                                                                            Methods

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility

                                                                                                                                                                            On This Page

                                                                                                                                                                            Methods
                                                                                                                                                                            +CKEvent | trilium
                                                                                                                                                                            trilium
                                                                                                                                                                              Preparing search index...

                                                                                                                                                                              Interface CKEvent

                                                                                                                                                                              interface CKEvent {
                                                                                                                                                                                  stop(): void;
                                                                                                                                                                              }
                                                                                                                                                                              Index

                                                                                                                                                                              Methods

                                                                                                                                                                              stop +

                                                                                                                                                                              Methods

                                                                                                                                                                              Settings

                                                                                                                                                                              Member Visibility

                                                                                                                                                                              On This Page

                                                                                                                                                                              Methods
                                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CKNode.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.CKNode.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.CKNode.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.CKNode.html index 2f65f4447..42db435b2 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CKNode.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.CKNode.html @@ -1,4 +1,4 @@ -CKNode | trilium
                                                                                                                                                                              trilium
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Interface CKNode

                                                                                                                                                                                interface CKNode {
                                                                                                                                                                                    _children: CKNode[];
                                                                                                                                                                                    childCount: number;
                                                                                                                                                                                    data: string;
                                                                                                                                                                                    isEmpty: boolean;
                                                                                                                                                                                    name: string;
                                                                                                                                                                                    root: {
                                                                                                                                                                                        document: {
                                                                                                                                                                                            model: {
                                                                                                                                                                                                markers: { getMarkersIntersectingRange(range: TextRange): Marker[] };
                                                                                                                                                                                                createRangeIn(el: CKNode): TextRange;
                                                                                                                                                                                            };
                                                                                                                                                                                        };
                                                                                                                                                                                    };
                                                                                                                                                                                    startOffset: number;
                                                                                                                                                                                    getAttribute(name: string): string;
                                                                                                                                                                                    getChild(index: number): CKNode;
                                                                                                                                                                                    is(type: string, name?: string): any;
                                                                                                                                                                                    toJSON(): object;
                                                                                                                                                                                }
                                                                                                                                                                                Index

                                                                                                                                                                                Properties

                                                                                                                                                                                _children +CKNode | trilium
                                                                                                                                                                                trilium
                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                  Interface CKNode

                                                                                                                                                                                  interface CKNode {
                                                                                                                                                                                      _children: CKNode[];
                                                                                                                                                                                      childCount: number;
                                                                                                                                                                                      data: string;
                                                                                                                                                                                      isEmpty: boolean;
                                                                                                                                                                                      name: string;
                                                                                                                                                                                      root: {
                                                                                                                                                                                          document: {
                                                                                                                                                                                              model: {
                                                                                                                                                                                                  markers: { getMarkersIntersectingRange(range: TextRange): Marker[] };
                                                                                                                                                                                                  createRangeIn(el: CKNode): TextRange;
                                                                                                                                                                                              };
                                                                                                                                                                                          };
                                                                                                                                                                                      };
                                                                                                                                                                                      startOffset: number;
                                                                                                                                                                                      getAttribute(name: string): string;
                                                                                                                                                                                      getChild(index: number): CKNode;
                                                                                                                                                                                      is(type: string, name?: string): any;
                                                                                                                                                                                      toJSON(): object;
                                                                                                                                                                                  }
                                                                                                                                                                                  Index

                                                                                                                                                                                  Properties

                                                                                                                                                                                  _children childCount data isEmpty @@ -9,4 +9,4 @@ getChild is toJSON -

                                                                                                                                                                                  Properties

                                                                                                                                                                                  _children

                                                                                                                                                                                  _children: CKNode[]
                                                                                                                                                                                  childCount: number
                                                                                                                                                                                  data: string
                                                                                                                                                                                  isEmpty: boolean
                                                                                                                                                                                  name: string
                                                                                                                                                                                  root: {
                                                                                                                                                                                      document: {
                                                                                                                                                                                          model: {
                                                                                                                                                                                              markers: { getMarkersIntersectingRange(range: TextRange): Marker[] };
                                                                                                                                                                                              createRangeIn(el: CKNode): TextRange;
                                                                                                                                                                                          };
                                                                                                                                                                                      };
                                                                                                                                                                                  }
                                                                                                                                                                                  startOffset: number

                                                                                                                                                                                  Methods

                                                                                                                                                                                  Settings

                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                  On This Page

                                                                                                                                                                                  Properties
                                                                                                                                                                                  Methods
                                                                                                                                                                                  +

                                                                                                                                                                                  Properties

                                                                                                                                                                                  _children

                                                                                                                                                                                  _children: CKNode[]
                                                                                                                                                                                  childCount: number
                                                                                                                                                                                  data: string
                                                                                                                                                                                  isEmpty: boolean
                                                                                                                                                                                  name: string
                                                                                                                                                                                  root: {
                                                                                                                                                                                      document: {
                                                                                                                                                                                          model: {
                                                                                                                                                                                              markers: { getMarkersIntersectingRange(range: TextRange): Marker[] };
                                                                                                                                                                                              createRangeIn(el: CKNode): TextRange;
                                                                                                                                                                                          };
                                                                                                                                                                                      };
                                                                                                                                                                                  }
                                                                                                                                                                                  startOffset: number

                                                                                                                                                                                  Methods

                                                                                                                                                                                  Settings

                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                  On This Page

                                                                                                                                                                                  Properties
                                                                                                                                                                                  Methods
                                                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CodeMirrorInstance.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.CodeMirrorInstance.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.CodeMirrorInstance.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.CodeMirrorInstance.html index 91d964ff5..bd73e05ed 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CodeMirrorInstance.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.CodeMirrorInstance.html @@ -1,4 +1,4 @@ -CodeMirrorInstance | trilium
                                                                                                                                                                                  trilium
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Interface CodeMirrorInstance

                                                                                                                                                                                    interface CodeMirrorInstance {
                                                                                                                                                                                        doc: {
                                                                                                                                                                                            getValue(): string;
                                                                                                                                                                                            markText(
                                                                                                                                                                                                from: number | { ch: number; line: number },
                                                                                                                                                                                                to: number | { ch: number; line: number },
                                                                                                                                                                                                opts: { className: string },
                                                                                                                                                                                            ): any;
                                                                                                                                                                                            replaceRange(text: string, from: number, to: number): any;
                                                                                                                                                                                            setSelection(from: number, to: number): any;
                                                                                                                                                                                        };
                                                                                                                                                                                        clearHistory(): any;
                                                                                                                                                                                        focus(): any;
                                                                                                                                                                                        getCursor(): { ch: number; col: number; line: number };
                                                                                                                                                                                        getSelection(): string;
                                                                                                                                                                                        getValue(): string;
                                                                                                                                                                                        lineCount(): number;
                                                                                                                                                                                        on(event: string, callback: () => void): any;
                                                                                                                                                                                        operation(callback: () => void): any;
                                                                                                                                                                                        refresh(): any;
                                                                                                                                                                                        scrollIntoView(pos: number): any;
                                                                                                                                                                                        setCursor(line: number, col: number): any;
                                                                                                                                                                                        setOption(name: string, value: string): any;
                                                                                                                                                                                        setValue(val: string): any;
                                                                                                                                                                                    }
                                                                                                                                                                                    Index

                                                                                                                                                                                    Properties

                                                                                                                                                                                    doc +CodeMirrorInstance | trilium
                                                                                                                                                                                    trilium
                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                      Interface CodeMirrorInstance

                                                                                                                                                                                      interface CodeMirrorInstance {
                                                                                                                                                                                          doc: {
                                                                                                                                                                                              getValue(): string;
                                                                                                                                                                                              markText(
                                                                                                                                                                                                  from: number | { ch: number; line: number },
                                                                                                                                                                                                  to: number | { ch: number; line: number },
                                                                                                                                                                                                  opts: { className: string },
                                                                                                                                                                                              ): any;
                                                                                                                                                                                              replaceRange(text: string, from: number, to: number): any;
                                                                                                                                                                                              setSelection(from: number, to: number): any;
                                                                                                                                                                                          };
                                                                                                                                                                                          clearHistory(): any;
                                                                                                                                                                                          focus(): any;
                                                                                                                                                                                          getCursor(): { ch: number; col: number; line: number };
                                                                                                                                                                                          getSelection(): string;
                                                                                                                                                                                          getValue(): string;
                                                                                                                                                                                          lineCount(): number;
                                                                                                                                                                                          on(event: string, callback: () => void): any;
                                                                                                                                                                                          operation(callback: () => void): any;
                                                                                                                                                                                          refresh(): any;
                                                                                                                                                                                          scrollIntoView(pos: number): any;
                                                                                                                                                                                          setCursor(line: number, col: number): any;
                                                                                                                                                                                          setOption(name: string, value: string): any;
                                                                                                                                                                                          setValue(val: string): any;
                                                                                                                                                                                      }
                                                                                                                                                                                      Index

                                                                                                                                                                                      Properties

                                                                                                                                                                                      doc

                                                                                                                                                                                      Methods

                                                                                                                                                                                      clearHistory focus getCursor @@ -12,4 +12,4 @@ setCursor setOption setValue -

                                                                                                                                                                                      Properties

                                                                                                                                                                                      doc: {
                                                                                                                                                                                          getValue(): string;
                                                                                                                                                                                          markText(
                                                                                                                                                                                              from: number | { ch: number; line: number },
                                                                                                                                                                                              to: number | { ch: number; line: number },
                                                                                                                                                                                              opts: { className: string },
                                                                                                                                                                                          ): any;
                                                                                                                                                                                          replaceRange(text: string, from: number, to: number): any;
                                                                                                                                                                                          setSelection(from: number, to: number): any;
                                                                                                                                                                                      }

                                                                                                                                                                                      Methods

                                                                                                                                                                                      Settings

                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                      On This Page

                                                                                                                                                                                      Properties
                                                                                                                                                                                      Methods
                                                                                                                                                                                      +

                                                                                                                                                                                      Properties

                                                                                                                                                                                      doc: {
                                                                                                                                                                                          getValue(): string;
                                                                                                                                                                                          markText(
                                                                                                                                                                                              from: number | { ch: number; line: number },
                                                                                                                                                                                              to: number | { ch: number; line: number },
                                                                                                                                                                                              opts: { className: string },
                                                                                                                                                                                          ): any;
                                                                                                                                                                                          replaceRange(text: string, from: number, to: number): any;
                                                                                                                                                                                          setSelection(from: number, to: number): any;
                                                                                                                                                                                      }

                                                                                                                                                                                      Methods

                                                                                                                                                                                      Settings

                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                      On This Page

                                                                                                                                                                                      Properties
                                                                                                                                                                                      Methods
                                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CommandData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.CommandData.html similarity index 98% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.CommandData.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.CommandData.html index ae5ae67b7..f0d0cce74 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CommandData.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.CommandData.html @@ -1,3 +1,3 @@ CommandData | trilium
                                                                                                                                                                                      trilium
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Interface CommandData

                                                                                                                                                                                        Base interface for the data/arguments for a given command (see CommandMappings).

                                                                                                                                                                                        -
                                                                                                                                                                                        interface CommandData {
                                                                                                                                                                                            ntxId?: null | string;
                                                                                                                                                                                        }

                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                        Index

                                                                                                                                                                                        Properties

                                                                                                                                                                                        ntxId? -

                                                                                                                                                                                        Properties

                                                                                                                                                                                        ntxId?: null | string

                                                                                                                                                                                        Settings

                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                        On This Page

                                                                                                                                                                                        Properties
                                                                                                                                                                                        +
                                                                                                                                                                                        interface CommandData {
                                                                                                                                                                                            ntxId?: null | string;
                                                                                                                                                                                        }

                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                        Index

                                                                                                                                                                                        Properties

                                                                                                                                                                                        ntxId? +

                                                                                                                                                                                        Properties

                                                                                                                                                                                        ntxId?: null | string

                                                                                                                                                                                        Settings

                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                        On This Page

                                                                                                                                                                                        Properties
                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmDialogOptions.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ConfirmDialogOptions.html similarity index 97% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmDialogOptions.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.ConfirmDialogOptions.html index 7c686c74c..bf397f152 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmDialogOptions.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.ConfirmDialogOptions.html @@ -1,3 +1,3 @@ -ConfirmDialogOptions | trilium
                                                                                                                                                                                        trilium
                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                          Interface ConfirmDialogOptions

                                                                                                                                                                                          interface ConfirmDialogOptions {
                                                                                                                                                                                              confirmed: boolean;
                                                                                                                                                                                              isDeleteNoteChecked: boolean;
                                                                                                                                                                                          }
                                                                                                                                                                                          Index

                                                                                                                                                                                          Properties

                                                                                                                                                                                          confirmed +ConfirmDialogOptions | trilium
                                                                                                                                                                                          trilium
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            Interface ConfirmDialogOptions

                                                                                                                                                                                            interface ConfirmDialogOptions {
                                                                                                                                                                                                confirmed: boolean;
                                                                                                                                                                                                isDeleteNoteChecked: boolean;
                                                                                                                                                                                            }
                                                                                                                                                                                            Index

                                                                                                                                                                                            Properties

                                                                                                                                                                                            confirmed isDeleteNoteChecked -

                                                                                                                                                                                            Properties

                                                                                                                                                                                            confirmed: boolean
                                                                                                                                                                                            isDeleteNoteChecked: boolean

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                            On This Page

                                                                                                                                                                                            Properties
                                                                                                                                                                                            +

                                                                                                                                                                                            Properties

                                                                                                                                                                                            confirmed: boolean
                                                                                                                                                                                            isDeleteNoteChecked: boolean

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                            On This Page

                                                                                                                                                                                            Properties
                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmWithMessageOptions.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ConfirmWithMessageOptions.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmWithMessageOptions.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.ConfirmWithMessageOptions.html index 97455649a..06317d046 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmWithMessageOptions.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.ConfirmWithMessageOptions.html @@ -1,3 +1,3 @@ -ConfirmWithMessageOptions | trilium
                                                                                                                                                                                            trilium
                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                              Interface ConfirmWithMessageOptions

                                                                                                                                                                                              interface ConfirmWithMessageOptions {
                                                                                                                                                                                                  callback: ConfirmDialogCallback;
                                                                                                                                                                                                  message: string | HTMLElement | JQuery<HTMLElement>;
                                                                                                                                                                                              }
                                                                                                                                                                                              Index

                                                                                                                                                                                              Properties

                                                                                                                                                                                              callback +ConfirmWithMessageOptions | trilium
                                                                                                                                                                                              trilium
                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                Interface ConfirmWithMessageOptions

                                                                                                                                                                                                interface ConfirmWithMessageOptions {
                                                                                                                                                                                                    callback: ConfirmDialogCallback;
                                                                                                                                                                                                    message: string | HTMLElement | JQuery<HTMLElement>;
                                                                                                                                                                                                }
                                                                                                                                                                                                Index

                                                                                                                                                                                                Properties

                                                                                                                                                                                                callback message -

                                                                                                                                                                                                Properties

                                                                                                                                                                                                callback: ConfirmDialogCallback
                                                                                                                                                                                                message: string | HTMLElement | JQuery<HTMLElement>

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                On This Page

                                                                                                                                                                                                Properties
                                                                                                                                                                                                +

                                                                                                                                                                                                Properties

                                                                                                                                                                                                callback: ConfirmDialogCallback
                                                                                                                                                                                                message: string | HTMLElement | JQuery<HTMLElement>

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                On This Page

                                                                                                                                                                                                Properties
                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmWithTitleOptions.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ConfirmWithTitleOptions.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmWithTitleOptions.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.ConfirmWithTitleOptions.html index 4a1adee68..0a47f3cce 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmWithTitleOptions.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.ConfirmWithTitleOptions.html @@ -1,3 +1,3 @@ -ConfirmWithTitleOptions | trilium
                                                                                                                                                                                                trilium
                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                  Interface ConfirmWithTitleOptions

                                                                                                                                                                                                  interface ConfirmWithTitleOptions {
                                                                                                                                                                                                      callback: ConfirmDialogCallback;
                                                                                                                                                                                                      title: string;
                                                                                                                                                                                                  }
                                                                                                                                                                                                  Index

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  callback +ConfirmWithTitleOptions | trilium
                                                                                                                                                                                                  trilium
                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                    Interface ConfirmWithTitleOptions

                                                                                                                                                                                                    interface ConfirmWithTitleOptions {
                                                                                                                                                                                                        callback: ConfirmDialogCallback;
                                                                                                                                                                                                        title: string;
                                                                                                                                                                                                    }
                                                                                                                                                                                                    Index

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    callback title -

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    callback: ConfirmDialogCallback
                                                                                                                                                                                                    title: string

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                    Properties
                                                                                                                                                                                                    +

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    callback: ConfirmDialogCallback
                                                                                                                                                                                                    title: string

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                    Properties
                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ContextMenuCommandData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ContextMenuCommandData.html similarity index 95% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.ContextMenuCommandData.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.ContextMenuCommandData.html index 2cd0ceed5..51613b507 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ContextMenuCommandData.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.ContextMenuCommandData.html @@ -1,8 +1,8 @@ ContextMenuCommandData | trilium
                                                                                                                                                                                                    trilium
                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                      Interface ContextMenuCommandData

                                                                                                                                                                                                      Represents a set of commands that are triggered from the context menu, providing information such as the selected note.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      interface ContextMenuCommandData {
                                                                                                                                                                                                          node: FancytreeNode;
                                                                                                                                                                                                          noteId?: string;
                                                                                                                                                                                                          notePath?: string;
                                                                                                                                                                                                          ntxId?: null | string;
                                                                                                                                                                                                          selectedOrActiveBranchIds?: any;
                                                                                                                                                                                                          selectedOrActiveNoteIds: any;
                                                                                                                                                                                                      }

                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                      Index

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      node +
                                                                                                                                                                                                      interface ContextMenuCommandData {
                                                                                                                                                                                                          node: FancytreeNode;
                                                                                                                                                                                                          noteId?: string;
                                                                                                                                                                                                          notePath?: string;
                                                                                                                                                                                                          ntxId?: null | string;
                                                                                                                                                                                                          selectedOrActiveBranchIds?: any;
                                                                                                                                                                                                          selectedOrActiveNoteIds: any;
                                                                                                                                                                                                      }

                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                      Index

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      node noteId? notePath? ntxId? selectedOrActiveBranchIds? selectedOrActiveNoteIds -

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      node: FancytreeNode
                                                                                                                                                                                                      noteId?: string
                                                                                                                                                                                                      notePath?: string
                                                                                                                                                                                                      ntxId?: null | string
                                                                                                                                                                                                      selectedOrActiveBranchIds?: any
                                                                                                                                                                                                      selectedOrActiveNoteIds: any

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                      Properties
                                                                                                                                                                                                      +

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      node: FancytreeNode
                                                                                                                                                                                                      noteId?: string
                                                                                                                                                                                                      notePath?: string
                                                                                                                                                                                                      ntxId?: null | string
                                                                                                                                                                                                      selectedOrActiveBranchIds?: any
                                                                                                                                                                                                      selectedOrActiveNoteIds: any

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                      Properties
                                                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CreateLinkOptions.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.CreateLinkOptions.html similarity index 95% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.CreateLinkOptions.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.CreateLinkOptions.html index 6a9040241..7bacd808f 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CreateLinkOptions.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.CreateLinkOptions.html @@ -1,8 +1,8 @@ -CreateLinkOptions | trilium
                                                                                                                                                                                                      trilium
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                        Interface CreateLinkOptions

                                                                                                                                                                                                        interface CreateLinkOptions {
                                                                                                                                                                                                            autoConvertToImage?: boolean;
                                                                                                                                                                                                            referenceLink?: boolean;
                                                                                                                                                                                                            showNoteIcon?: boolean;
                                                                                                                                                                                                            showNotePath?: boolean;
                                                                                                                                                                                                            showTooltip?: boolean;
                                                                                                                                                                                                            title?: string;
                                                                                                                                                                                                            viewScope?: ViewScope;
                                                                                                                                                                                                        }
                                                                                                                                                                                                        Index

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        autoConvertToImage? +CreateLinkOptions | trilium
                                                                                                                                                                                                        trilium
                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                          Interface CreateLinkOptions

                                                                                                                                                                                                          interface CreateLinkOptions {
                                                                                                                                                                                                              autoConvertToImage?: boolean;
                                                                                                                                                                                                              referenceLink?: boolean;
                                                                                                                                                                                                              showNoteIcon?: boolean;
                                                                                                                                                                                                              showNotePath?: boolean;
                                                                                                                                                                                                              showTooltip?: boolean;
                                                                                                                                                                                                              title?: string;
                                                                                                                                                                                                              viewScope?: ViewScope;
                                                                                                                                                                                                          }
                                                                                                                                                                                                          Index

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          autoConvertToImage? referenceLink? showNoteIcon? showNotePath? showTooltip? title? viewScope? -

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          autoConvertToImage?: boolean
                                                                                                                                                                                                          referenceLink?: boolean
                                                                                                                                                                                                          showNoteIcon?: boolean
                                                                                                                                                                                                          showNotePath?: boolean
                                                                                                                                                                                                          showTooltip?: boolean
                                                                                                                                                                                                          title?: string
                                                                                                                                                                                                          viewScope?: ViewScope

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                          Properties
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          autoConvertToImage?: boolean
                                                                                                                                                                                                          referenceLink?: boolean
                                                                                                                                                                                                          showNoteIcon?: boolean
                                                                                                                                                                                                          showNotePath?: boolean
                                                                                                                                                                                                          showTooltip?: boolean
                                                                                                                                                                                                          title?: string
                                                                                                                                                                                                          viewScope?: ViewScope

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                          Properties
                                                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.DefinitionObject.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.DefinitionObject.html similarity index 95% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.DefinitionObject.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.DefinitionObject.html index e06f9317c..021bcbfd4 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.DefinitionObject.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.DefinitionObject.html @@ -1,7 +1,7 @@ -DefinitionObject | trilium
                                                                                                                                                                                                          trilium
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            Interface DefinitionObject

                                                                                                                                                                                                            interface DefinitionObject {
                                                                                                                                                                                                                inverseRelation?: string;
                                                                                                                                                                                                                isPromoted?: boolean;
                                                                                                                                                                                                                labelType?: LabelType;
                                                                                                                                                                                                                multiplicity?: Multiplicity;
                                                                                                                                                                                                                numberPrecision?: number;
                                                                                                                                                                                                                promotedAlias?: string;
                                                                                                                                                                                                            }
                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            inverseRelation? +DefinitionObject | trilium
                                                                                                                                                                                                            trilium
                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                              Interface DefinitionObject

                                                                                                                                                                                                              interface DefinitionObject {
                                                                                                                                                                                                                  inverseRelation?: string;
                                                                                                                                                                                                                  isPromoted?: boolean;
                                                                                                                                                                                                                  labelType?: LabelType;
                                                                                                                                                                                                                  multiplicity?: Multiplicity;
                                                                                                                                                                                                                  numberPrecision?: number;
                                                                                                                                                                                                                  promotedAlias?: string;
                                                                                                                                                                                                              }
                                                                                                                                                                                                              Index

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              inverseRelation? isPromoted? labelType? multiplicity? numberPrecision? promotedAlias? -

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              inverseRelation?: string
                                                                                                                                                                                                              isPromoted?: boolean
                                                                                                                                                                                                              labelType?: LabelType
                                                                                                                                                                                                              multiplicity?: Multiplicity
                                                                                                                                                                                                              numberPrecision?: number
                                                                                                                                                                                                              promotedAlias?: string

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                              Properties
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              inverseRelation?: string
                                                                                                                                                                                                              isPromoted?: boolean
                                                                                                                                                                                                              labelType?: LabelType
                                                                                                                                                                                                              multiplicity?: Multiplicity
                                                                                                                                                                                                              numberPrecision?: number
                                                                                                                                                                                                              promotedAlias?: string

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                              Properties
                                                                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.DragAndDrop5.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.DragAndDrop5.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.DragAndDrop5.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.DragAndDrop5.html index 34eae1f91..010014f22 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.DragAndDrop5.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.DragAndDrop5.html @@ -1,5 +1,5 @@ DragAndDrop5 | trilium
                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Interface DragAndDrop5

                                                                                                                                                                                                                interface DragAndDrop5 {
                                                                                                                                                                                                                    autoExpandMS?: number;
                                                                                                                                                                                                                    dragDrag?: (sourceNode: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                    dragDrop?: (node: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                    dragEnd?: (sourceNode: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                    dragEnter?: (targetNode: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                    dragExpand?: (targetNode: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                    dragLeave?: (targetNode: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                    dragOver?: (targetNode: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                    dragStart?: (sourceNode: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                    dropMarkerInsertOffsetX?: number;
                                                                                                                                                                                                                    dropMarkerOffsetX?: number;
                                                                                                                                                                                                                    multiSource?: boolean;
                                                                                                                                                                                                                    preventForeignNodes?: boolean;
                                                                                                                                                                                                                    preventNonNodes?: boolean;
                                                                                                                                                                                                                    preventRecursiveMoves?: boolean;
                                                                                                                                                                                                                    preventVoidMoves?: boolean;
                                                                                                                                                                                                                    scroll?: boolean;
                                                                                                                                                                                                                    scrollSensitivity?: number;
                                                                                                                                                                                                                    scrollSpeed?: number;
                                                                                                                                                                                                                    setTextTypeJson?: boolean;
                                                                                                                                                                                                                    [key: string]: any;
                                                                                                                                                                                                                }

                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                • [key: string]: any

                                                                                                                                                                                                                  Support misc options

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                autoExpandMS? +
                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                autoExpandMS? dragDrag? dragDrop? dragEnd? @@ -20,20 +20,20 @@ scrollSpeed? setTextTypeJson?

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                autoExpandMS?: number

                                                                                                                                                                                                                Expand nodes after n milliseconds of hovering.

                                                                                                                                                                                                                -
                                                                                                                                                                                                                dragDrag?: (sourceNode: FancytreeNode, data: any) => void
                                                                                                                                                                                                                dragDrop?: (node: FancytreeNode, data: any) => void

                                                                                                                                                                                                                Events (drag drop)

                                                                                                                                                                                                                -
                                                                                                                                                                                                                dragEnd?: (sourceNode: FancytreeNode, data: any) => void
                                                                                                                                                                                                                dragEnter?: (targetNode: FancytreeNode, data: any) => void

                                                                                                                                                                                                                Callback(targetNode, data), return true, to enable dnd drop

                                                                                                                                                                                                                -
                                                                                                                                                                                                                dragExpand?: (targetNode: FancytreeNode, data: any) => void

                                                                                                                                                                                                                Callback(targetNode, data), return false to prevent autoExpand

                                                                                                                                                                                                                -
                                                                                                                                                                                                                dragLeave?: (targetNode: FancytreeNode, data: any) => void
                                                                                                                                                                                                                dragOver?: (targetNode: FancytreeNode, data: any) => void

                                                                                                                                                                                                                Events (drag over)

                                                                                                                                                                                                                -
                                                                                                                                                                                                                dragStart?: (sourceNode: FancytreeNode, data: any) => void

                                                                                                                                                                                                                Callback(sourceNode, data), return true, to enable dnd drag

                                                                                                                                                                                                                -
                                                                                                                                                                                                                dropMarkerInsertOffsetX?: number

                                                                                                                                                                                                                Additional offset for drop-marker with hitMode = "before"/"after"

                                                                                                                                                                                                                -
                                                                                                                                                                                                                dropMarkerOffsetX?: number

                                                                                                                                                                                                                Absolute position offset for .fancytree-drop-marker

                                                                                                                                                                                                                -
                                                                                                                                                                                                                multiSource?: boolean

                                                                                                                                                                                                                true: Drag multiple (i.e. selected) nodes.

                                                                                                                                                                                                                -
                                                                                                                                                                                                                preventForeignNodes?: boolean

                                                                                                                                                                                                                Prevent dropping nodes from different Fancytrees

                                                                                                                                                                                                                -
                                                                                                                                                                                                                preventNonNodes?: boolean

                                                                                                                                                                                                                Prevent dropping items other than Fancytree nodes

                                                                                                                                                                                                                -
                                                                                                                                                                                                                preventRecursiveMoves?: boolean

                                                                                                                                                                                                                Prevent dropping nodes on own descendants

                                                                                                                                                                                                                -
                                                                                                                                                                                                                preventVoidMoves?: boolean

                                                                                                                                                                                                                Prevent dropping nodes 'before self', etc.

                                                                                                                                                                                                                -
                                                                                                                                                                                                                scroll?: boolean

                                                                                                                                                                                                                Enable auto-scrolling while dragging

                                                                                                                                                                                                                -
                                                                                                                                                                                                                scrollSensitivity?: number

                                                                                                                                                                                                                Active top/bottom margin in pixel

                                                                                                                                                                                                                -
                                                                                                                                                                                                                scrollSpeed?: number

                                                                                                                                                                                                                Pixel per event

                                                                                                                                                                                                                -
                                                                                                                                                                                                                setTextTypeJson?: boolean

                                                                                                                                                                                                                Allow dragging of nodes to different IE windows, default: false

                                                                                                                                                                                                                -

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                +
                                                                                                                                                                                                                dragDrag?: (sourceNode: FancytreeNode, data: any) => void
                                                                                                                                                                                                                dragDrop?: (node: FancytreeNode, data: any) => void

                                                                                                                                                                                                                Events (drag drop)

                                                                                                                                                                                                                +
                                                                                                                                                                                                                dragEnd?: (sourceNode: FancytreeNode, data: any) => void
                                                                                                                                                                                                                dragEnter?: (targetNode: FancytreeNode, data: any) => void

                                                                                                                                                                                                                Callback(targetNode, data), return true, to enable dnd drop

                                                                                                                                                                                                                +
                                                                                                                                                                                                                dragExpand?: (targetNode: FancytreeNode, data: any) => void

                                                                                                                                                                                                                Callback(targetNode, data), return false to prevent autoExpand

                                                                                                                                                                                                                +
                                                                                                                                                                                                                dragLeave?: (targetNode: FancytreeNode, data: any) => void
                                                                                                                                                                                                                dragOver?: (targetNode: FancytreeNode, data: any) => void

                                                                                                                                                                                                                Events (drag over)

                                                                                                                                                                                                                +
                                                                                                                                                                                                                dragStart?: (sourceNode: FancytreeNode, data: any) => void

                                                                                                                                                                                                                Callback(sourceNode, data), return true, to enable dnd drag

                                                                                                                                                                                                                +
                                                                                                                                                                                                                dropMarkerInsertOffsetX?: number

                                                                                                                                                                                                                Additional offset for drop-marker with hitMode = "before"/"after"

                                                                                                                                                                                                                +
                                                                                                                                                                                                                dropMarkerOffsetX?: number

                                                                                                                                                                                                                Absolute position offset for .fancytree-drop-marker

                                                                                                                                                                                                                +
                                                                                                                                                                                                                multiSource?: boolean

                                                                                                                                                                                                                true: Drag multiple (i.e. selected) nodes.

                                                                                                                                                                                                                +
                                                                                                                                                                                                                preventForeignNodes?: boolean

                                                                                                                                                                                                                Prevent dropping nodes from different Fancytrees

                                                                                                                                                                                                                +
                                                                                                                                                                                                                preventNonNodes?: boolean

                                                                                                                                                                                                                Prevent dropping items other than Fancytree nodes

                                                                                                                                                                                                                +
                                                                                                                                                                                                                preventRecursiveMoves?: boolean

                                                                                                                                                                                                                Prevent dropping nodes on own descendants

                                                                                                                                                                                                                +
                                                                                                                                                                                                                preventVoidMoves?: boolean

                                                                                                                                                                                                                Prevent dropping nodes 'before self', etc.

                                                                                                                                                                                                                +
                                                                                                                                                                                                                scroll?: boolean

                                                                                                                                                                                                                Enable auto-scrolling while dragging

                                                                                                                                                                                                                +
                                                                                                                                                                                                                scrollSensitivity?: number

                                                                                                                                                                                                                Active top/bottom margin in pixel

                                                                                                                                                                                                                +
                                                                                                                                                                                                                scrollSpeed?: number

                                                                                                                                                                                                                Pixel per event

                                                                                                                                                                                                                +
                                                                                                                                                                                                                setTextTypeJson?: boolean

                                                                                                                                                                                                                Allow dragging of nodes to different IE windows, default: false

                                                                                                                                                                                                                +

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Event.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Event.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.Event.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.Event.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.EventData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.EventData.html similarity index 97% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.EventData.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.EventData.html index 3d448a794..e86edfdd5 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.EventData.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.EventData.html @@ -1,5 +1,5 @@ EventData | trilium
                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                  Interface EventData

                                                                                                                                                                                                                  Context object passed to events and hook functions.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  interface EventData {
                                                                                                                                                                                                                      node: FancytreeNode;
                                                                                                                                                                                                                      options: FancytreeOptions;
                                                                                                                                                                                                                      originalEvent: JQueryEventObject;
                                                                                                                                                                                                                      response: any;
                                                                                                                                                                                                                      result: any;
                                                                                                                                                                                                                      targetType: string;
                                                                                                                                                                                                                      tree: Fancytree;
                                                                                                                                                                                                                      widget: any;
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  node +
                                                                                                                                                                                                                  interface EventData {
                                                                                                                                                                                                                      node: FancytreeNode;
                                                                                                                                                                                                                      options: FancytreeOptions;
                                                                                                                                                                                                                      originalEvent: JQueryEventObject;
                                                                                                                                                                                                                      response: any;
                                                                                                                                                                                                                      result: any;
                                                                                                                                                                                                                      targetType: string;
                                                                                                                                                                                                                      tree: Fancytree;
                                                                                                                                                                                                                      widget: any;
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  node options originalEvent response @@ -8,12 +8,12 @@ tree widget

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  node: FancytreeNode

                                                                                                                                                                                                                  The node that this call applies to (null for tree events)

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  options: FancytreeOptions

                                                                                                                                                                                                                  Shortcut to tree.options

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  originalEvent: JQueryEventObject

                                                                                                                                                                                                                  The jQuery Event that initially triggered this call

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  response: any

                                                                                                                                                                                                                  (only for postProcess event) Original ajax response

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  result: any

                                                                                                                                                                                                                  (output parameter) Event handlers can return values back to the +

                                                                                                                                                                                                                  options: FancytreeOptions

                                                                                                                                                                                                                  Shortcut to tree.options

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  originalEvent: JQueryEventObject

                                                                                                                                                                                                                  The jQuery Event that initially triggered this call

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  response: any

                                                                                                                                                                                                                  (only for postProcess event) Original ajax response

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  result: any

                                                                                                                                                                                                                  (output parameter) Event handlers can return values back to the caller. Used by lazyLoad, postProcess, ...

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  targetType: string

                                                                                                                                                                                                                  (only for click and dblclick events) 'title' | 'prefix' | 'expander' | 'checkbox' | 'icon'

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  tree: Fancytree

                                                                                                                                                                                                                  The tree instance

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  widget: any

                                                                                                                                                                                                                  The jQuery UI tree widget

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  targetType: string

                                                                                                                                                                                                                  (only for click and dblclick events) 'title' | 'prefix' | 'expander' | 'checkbox' | 'icon'

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  tree: Fancytree

                                                                                                                                                                                                                  The tree instance

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  widget: any

                                                                                                                                                                                                                  The jQuery UI tree widget

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ExecuteCommandData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ExecuteCommandData.html similarity index 97% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.ExecuteCommandData.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.ExecuteCommandData.html index 8524ddd29..bebbf94ab 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ExecuteCommandData.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.ExecuteCommandData.html @@ -1,4 +1,4 @@ ExecuteCommandData | trilium
                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                    Interface ExecuteCommandData<T>

                                                                                                                                                                                                                    Base interface for the data/arguments for a given command (see CommandMappings).

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    interface ExecuteCommandData<T> {
                                                                                                                                                                                                                        ntxId?: null | string;
                                                                                                                                                                                                                        resolve: (data: T) => void;
                                                                                                                                                                                                                    }

                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    ntxId? +
                                                                                                                                                                                                                    interface ExecuteCommandData<T> {
                                                                                                                                                                                                                        ntxId?: null | string;
                                                                                                                                                                                                                        resolve: (data: T) => void;
                                                                                                                                                                                                                    }

                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    ntxId? resolve -

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    ntxId?: null | string
                                                                                                                                                                                                                    resolve: (data: T) => void

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    ntxId?: null | string
                                                                                                                                                                                                                    resolve: (data: T) => void

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FAttachmentRow.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.FAttachmentRow.html similarity index 94% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.FAttachmentRow.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.FAttachmentRow.html index 407515b16..91634ff19 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FAttachmentRow.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.FAttachmentRow.html @@ -1,4 +1,4 @@ -FAttachmentRow | trilium
                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                      Interface FAttachmentRow

                                                                                                                                                                                                                      interface FAttachmentRow {
                                                                                                                                                                                                                          attachmentId: string;
                                                                                                                                                                                                                          contentLength: number;
                                                                                                                                                                                                                          dateModified: string;
                                                                                                                                                                                                                          mime: string;
                                                                                                                                                                                                                          ownerId: string;
                                                                                                                                                                                                                          role: string;
                                                                                                                                                                                                                          title: string;
                                                                                                                                                                                                                          utcDateModified: string;
                                                                                                                                                                                                                          utcDateScheduledForErasureSince: string;
                                                                                                                                                                                                                      }
                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      attachmentId +FAttachmentRow | trilium
                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                        Interface FAttachmentRow

                                                                                                                                                                                                                        interface FAttachmentRow {
                                                                                                                                                                                                                            attachmentId: string;
                                                                                                                                                                                                                            contentLength: number;
                                                                                                                                                                                                                            dateModified: string;
                                                                                                                                                                                                                            mime: string;
                                                                                                                                                                                                                            ownerId: string;
                                                                                                                                                                                                                            role: string;
                                                                                                                                                                                                                            title: string;
                                                                                                                                                                                                                            utcDateModified: string;
                                                                                                                                                                                                                            utcDateScheduledForErasureSince: string;
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        attachmentId contentLength dateModified mime @@ -7,4 +7,4 @@ title utcDateModified utcDateScheduledForErasureSince -

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        attachmentId: string
                                                                                                                                                                                                                        contentLength: number
                                                                                                                                                                                                                        dateModified: string
                                                                                                                                                                                                                        mime: string
                                                                                                                                                                                                                        ownerId: string
                                                                                                                                                                                                                        role: string
                                                                                                                                                                                                                        title: string
                                                                                                                                                                                                                        utcDateModified: string
                                                                                                                                                                                                                        utcDateScheduledForErasureSince: string

                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        attachmentId: string
                                                                                                                                                                                                                        contentLength: number
                                                                                                                                                                                                                        dateModified: string
                                                                                                                                                                                                                        mime: string
                                                                                                                                                                                                                        ownerId: string
                                                                                                                                                                                                                        role: string
                                                                                                                                                                                                                        title: string
                                                                                                                                                                                                                        utcDateModified: string
                                                                                                                                                                                                                        utcDateScheduledForErasureSince: string

                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FAttributeRow.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.FAttributeRow.html similarity index 94% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.FAttributeRow.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.FAttributeRow.html index 586d0a0f2..dc378f2a3 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FAttributeRow.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.FAttributeRow.html @@ -1,8 +1,8 @@ -FAttributeRow | trilium
                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                          Interface FAttributeRow

                                                                                                                                                                                                                          interface FAttributeRow {
                                                                                                                                                                                                                              attributeId: string;
                                                                                                                                                                                                                              isInheritable: boolean;
                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                              noteId: string;
                                                                                                                                                                                                                              position: number;
                                                                                                                                                                                                                              type: AttributeType;
                                                                                                                                                                                                                              value: string;
                                                                                                                                                                                                                          }
                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          attributeId +FAttributeRow | trilium
                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                            Interface FAttributeRow

                                                                                                                                                                                                                            interface FAttributeRow {
                                                                                                                                                                                                                                attributeId: string;
                                                                                                                                                                                                                                isInheritable: boolean;
                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                noteId: string;
                                                                                                                                                                                                                                position: number;
                                                                                                                                                                                                                                type: AttributeType;
                                                                                                                                                                                                                                value: string;
                                                                                                                                                                                                                            }
                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            attributeId isInheritable name noteId position type value -

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            attributeId: string
                                                                                                                                                                                                                            isInheritable: boolean
                                                                                                                                                                                                                            name: string
                                                                                                                                                                                                                            noteId: string
                                                                                                                                                                                                                            position: number
                                                                                                                                                                                                                            type: AttributeType
                                                                                                                                                                                                                            value: string

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            attributeId: string
                                                                                                                                                                                                                            isInheritable: boolean
                                                                                                                                                                                                                            name: string
                                                                                                                                                                                                                            noteId: string
                                                                                                                                                                                                                            position: number
                                                                                                                                                                                                                            type: AttributeType
                                                                                                                                                                                                                            value: string

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FBranchRow.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.FBranchRow.html similarity index 95% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.FBranchRow.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.FBranchRow.html index 6436f5b6c..676db9ea2 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FBranchRow.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.FBranchRow.html @@ -1,4 +1,4 @@ -FBranchRow | trilium
                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                              Interface FBranchRow

                                                                                                                                                                                                                              interface FBranchRow {
                                                                                                                                                                                                                                  branchId: string;
                                                                                                                                                                                                                                  fromSearchNote: boolean;
                                                                                                                                                                                                                                  isDeleted?: boolean;
                                                                                                                                                                                                                                  isExpanded?: boolean;
                                                                                                                                                                                                                                  noteId: string;
                                                                                                                                                                                                                                  notePosition: number;
                                                                                                                                                                                                                                  parentNoteId: string;
                                                                                                                                                                                                                                  prefix?: string;
                                                                                                                                                                                                                              }
                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              branchId +FBranchRow | trilium
                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                Interface FBranchRow

                                                                                                                                                                                                                                interface FBranchRow {
                                                                                                                                                                                                                                    branchId: string;
                                                                                                                                                                                                                                    fromSearchNote: boolean;
                                                                                                                                                                                                                                    isDeleted?: boolean;
                                                                                                                                                                                                                                    isExpanded?: boolean;
                                                                                                                                                                                                                                    noteId: string;
                                                                                                                                                                                                                                    notePosition: number;
                                                                                                                                                                                                                                    parentNoteId: string;
                                                                                                                                                                                                                                    prefix?: string;
                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                branchId fromSearchNote isDeleted? isExpanded? @@ -6,4 +6,4 @@ notePosition parentNoteId prefix? -

                                                                                                                                                                                                                                Properties

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

                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Properties

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

                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FNoteRow.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.FNoteRow.html similarity index 95% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.FNoteRow.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.FNoteRow.html index 85eaa3670..b0cd6edee 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FNoteRow.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.FNoteRow.html @@ -1,7 +1,7 @@ -FNoteRow | trilium
                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                  Interface FNoteRow

                                                                                                                                                                                                                                  interface FNoteRow {
                                                                                                                                                                                                                                      blobId: string;
                                                                                                                                                                                                                                      isProtected: boolean;
                                                                                                                                                                                                                                      mime: string;
                                                                                                                                                                                                                                      noteId: string;
                                                                                                                                                                                                                                      title: string;
                                                                                                                                                                                                                                      type: NoteType;
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  blobId +FNoteRow | trilium
                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                    Interface FNoteRow

                                                                                                                                                                                                                                    interface FNoteRow {
                                                                                                                                                                                                                                        blobId: string;
                                                                                                                                                                                                                                        isProtected: boolean;
                                                                                                                                                                                                                                        mime: string;
                                                                                                                                                                                                                                        noteId: string;
                                                                                                                                                                                                                                        title: string;
                                                                                                                                                                                                                                        type: NoteType;
                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    blobId isProtected mime noteId title type -

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    blobId: string
                                                                                                                                                                                                                                    isProtected: boolean
                                                                                                                                                                                                                                    mime: string
                                                                                                                                                                                                                                    noteId: string
                                                                                                                                                                                                                                    title: string
                                                                                                                                                                                                                                    type: NoteType

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    blobId: string
                                                                                                                                                                                                                                    isProtected: boolean
                                                                                                                                                                                                                                    mime: string
                                                                                                                                                                                                                                    noteId: string
                                                                                                                                                                                                                                    title: string
                                                                                                                                                                                                                                    type: NoteType

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Fancytree.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Fancytree.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.Fancytree.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.Fancytree.html index 0d6ae776b..7002b2f1d 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Fancytree.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.Fancytree.html @@ -1,4 +1,4 @@ -Fancytree | trilium
                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                      Interface Fancytree

                                                                                                                                                                                                                                      interface Fancytree {
                                                                                                                                                                                                                                          $container: JQuery;
                                                                                                                                                                                                                                          $div: JQuery;
                                                                                                                                                                                                                                          focusNode: FancytreeNode;
                                                                                                                                                                                                                                          options: FancytreeOptions;
                                                                                                                                                                                                                                          rootNode: FancytreeNode;
                                                                                                                                                                                                                                          widget: any;
                                                                                                                                                                                                                                          activateKey(key: string | boolean): FancytreeNode;
                                                                                                                                                                                                                                          applyPatch(patchList: NodePatch[]): JQueryPromise<any>;
                                                                                                                                                                                                                                          changeRefKey(oldRefKey: string, newRefKey: string): void;
                                                                                                                                                                                                                                          clearCookies(): void;
                                                                                                                                                                                                                                          clearFilter(): void;
                                                                                                                                                                                                                                          count(): number;
                                                                                                                                                                                                                                          debug(msg: any): void;
                                                                                                                                                                                                                                          enableUpdate(enabled: boolean): void;
                                                                                                                                                                                                                                          expandAll(flag?: boolean, options?: Object): void;
                                                                                                                                                                                                                                          filterBranches(filter: string): number;
                                                                                                                                                                                                                                          filterBranches(filter: (node: FancytreeNode) => boolean): number;
                                                                                                                                                                                                                                          filterNodes(filter: string, leavesOnly?: boolean): number;
                                                                                                                                                                                                                                          filterNodes(
                                                                                                                                                                                                                                              filter: (node: FancytreeNode) => boolean,
                                                                                                                                                                                                                                              leavesOnly?: boolean,
                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                          findAll(
                                                                                                                                                                                                                                              match: string | ((node: FancytreeNode) => undefined | boolean),
                                                                                                                                                                                                                                          ): FancytreeNode[];
                                                                                                                                                                                                                                          findNextNode(match: string, startNode?: FancytreeNode): FancytreeNode;
                                                                                                                                                                                                                                          findNextNode(
                                                                                                                                                                                                                                              match: (node: FancytreeNode) => boolean,
                                                                                                                                                                                                                                              startNode?: FancytreeNode,
                                                                                                                                                                                                                                          ): FancytreeNode;
                                                                                                                                                                                                                                          generateFormElements(selected?: boolean, active?: boolean): void;
                                                                                                                                                                                                                                          getActiveNode(): FancytreeNode;
                                                                                                                                                                                                                                          getFirstChild(): FancytreeNode;
                                                                                                                                                                                                                                          getFocusNode(ifTreeHasFocus?: boolean): FancytreeNode;
                                                                                                                                                                                                                                          getNodeByKey(key: string, searchRoot?: FancytreeNode): FancytreeNode;
                                                                                                                                                                                                                                          getNodesByRef(refKey: string, rootNode?: FancytreeNode): FancytreeNode[];
                                                                                                                                                                                                                                          getPersistData(): PersistData;
                                                                                                                                                                                                                                          getRootNode(): FancytreeNode;
                                                                                                                                                                                                                                          getSelectedNodes(stopOnParents?: boolean): FancytreeNode[];
                                                                                                                                                                                                                                          hasFocus(): boolean;
                                                                                                                                                                                                                                          info(msg: any): void;
                                                                                                                                                                                                                                          isEditing(): FancytreeNode;
                                                                                                                                                                                                                                          loadKeyPath(
                                                                                                                                                                                                                                              keyPathList: string[],
                                                                                                                                                                                                                                              callback: (node: FancytreeNode, status: string) => void,
                                                                                                                                                                                                                                          ): JQueryPromise<any>;
                                                                                                                                                                                                                                          loadKeyPath(
                                                                                                                                                                                                                                              keyPath: string,
                                                                                                                                                                                                                                              callback: (node: FancytreeNode, status: string) => void,
                                                                                                                                                                                                                                          ): JQueryPromise<any>;
                                                                                                                                                                                                                                          reactivate(): void;
                                                                                                                                                                                                                                          reload(source?: any): JQueryPromise<any>;
                                                                                                                                                                                                                                          render(force?: boolean, deep?: boolean): void;
                                                                                                                                                                                                                                          setFocus(flag?: boolean): void;
                                                                                                                                                                                                                                          toDict(
                                                                                                                                                                                                                                              includeRoot?: boolean,
                                                                                                                                                                                                                                              callback?: (node: FancytreeNode) => void,
                                                                                                                                                                                                                                          ): any;
                                                                                                                                                                                                                                          visit(fn: (node: FancytreeNode) => any): boolean;
                                                                                                                                                                                                                                          warn(msg: any): void;
                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      $container +Fancytree | trilium
                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                        Interface Fancytree

                                                                                                                                                                                                                                        interface Fancytree {
                                                                                                                                                                                                                                            $container: JQuery;
                                                                                                                                                                                                                                            $div: JQuery;
                                                                                                                                                                                                                                            focusNode: FancytreeNode;
                                                                                                                                                                                                                                            options: FancytreeOptions;
                                                                                                                                                                                                                                            rootNode: FancytreeNode;
                                                                                                                                                                                                                                            widget: any;
                                                                                                                                                                                                                                            activateKey(key: string | boolean): FancytreeNode;
                                                                                                                                                                                                                                            applyPatch(patchList: NodePatch[]): JQueryPromise<any>;
                                                                                                                                                                                                                                            changeRefKey(oldRefKey: string, newRefKey: string): void;
                                                                                                                                                                                                                                            clearCookies(): void;
                                                                                                                                                                                                                                            clearFilter(): void;
                                                                                                                                                                                                                                            count(): number;
                                                                                                                                                                                                                                            debug(msg: any): void;
                                                                                                                                                                                                                                            enableUpdate(enabled: boolean): void;
                                                                                                                                                                                                                                            expandAll(flag?: boolean, options?: Object): void;
                                                                                                                                                                                                                                            filterBranches(filter: string): number;
                                                                                                                                                                                                                                            filterBranches(filter: (node: FancytreeNode) => boolean): number;
                                                                                                                                                                                                                                            filterNodes(filter: string, leavesOnly?: boolean): number;
                                                                                                                                                                                                                                            filterNodes(
                                                                                                                                                                                                                                                filter: (node: FancytreeNode) => boolean,
                                                                                                                                                                                                                                                leavesOnly?: boolean,
                                                                                                                                                                                                                                            ): number;
                                                                                                                                                                                                                                            findAll(
                                                                                                                                                                                                                                                match: string | ((node: FancytreeNode) => undefined | boolean),
                                                                                                                                                                                                                                            ): FancytreeNode[];
                                                                                                                                                                                                                                            findNextNode(match: string, startNode?: FancytreeNode): FancytreeNode;
                                                                                                                                                                                                                                            findNextNode(
                                                                                                                                                                                                                                                match: (node: FancytreeNode) => boolean,
                                                                                                                                                                                                                                                startNode?: FancytreeNode,
                                                                                                                                                                                                                                            ): FancytreeNode;
                                                                                                                                                                                                                                            generateFormElements(selected?: boolean, active?: boolean): void;
                                                                                                                                                                                                                                            getActiveNode(): FancytreeNode;
                                                                                                                                                                                                                                            getFirstChild(): FancytreeNode;
                                                                                                                                                                                                                                            getFocusNode(ifTreeHasFocus?: boolean): FancytreeNode;
                                                                                                                                                                                                                                            getNodeByKey(key: string, searchRoot?: FancytreeNode): FancytreeNode;
                                                                                                                                                                                                                                            getNodesByRef(refKey: string, rootNode?: FancytreeNode): FancytreeNode[];
                                                                                                                                                                                                                                            getPersistData(): PersistData;
                                                                                                                                                                                                                                            getRootNode(): FancytreeNode;
                                                                                                                                                                                                                                            getSelectedNodes(stopOnParents?: boolean): FancytreeNode[];
                                                                                                                                                                                                                                            hasFocus(): boolean;
                                                                                                                                                                                                                                            info(msg: any): void;
                                                                                                                                                                                                                                            isEditing(): FancytreeNode;
                                                                                                                                                                                                                                            loadKeyPath(
                                                                                                                                                                                                                                                keyPathList: string[],
                                                                                                                                                                                                                                                callback: (node: FancytreeNode, status: string) => void,
                                                                                                                                                                                                                                            ): JQueryPromise<any>;
                                                                                                                                                                                                                                            loadKeyPath(
                                                                                                                                                                                                                                                keyPath: string,
                                                                                                                                                                                                                                                callback: (node: FancytreeNode, status: string) => void,
                                                                                                                                                                                                                                            ): JQueryPromise<any>;
                                                                                                                                                                                                                                            reactivate(): void;
                                                                                                                                                                                                                                            reload(source?: any): JQueryPromise<any>;
                                                                                                                                                                                                                                            render(force?: boolean, deep?: boolean): void;
                                                                                                                                                                                                                                            setFocus(flag?: boolean): void;
                                                                                                                                                                                                                                            toDict(
                                                                                                                                                                                                                                                includeRoot?: boolean,
                                                                                                                                                                                                                                                callback?: (node: FancytreeNode) => void,
                                                                                                                                                                                                                                            ): any;
                                                                                                                                                                                                                                            visit(fn: (node: FancytreeNode) => any): boolean;
                                                                                                                                                                                                                                            warn(msg: any): void;
                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        $container $div focusNode options @@ -37,72 +37,72 @@ toDict visit warn -

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        $container: JQuery
                                                                                                                                                                                                                                        $div: JQuery
                                                                                                                                                                                                                                        focusNode: FancytreeNode
                                                                                                                                                                                                                                        options: FancytreeOptions
                                                                                                                                                                                                                                        rootNode: FancytreeNode
                                                                                                                                                                                                                                        widget: any

                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                        • Activate node with a given key and fire focus and +

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        $container: JQuery
                                                                                                                                                                                                                                        $div: JQuery
                                                                                                                                                                                                                                        focusNode: FancytreeNode
                                                                                                                                                                                                                                        options: FancytreeOptions
                                                                                                                                                                                                                                        rootNode: FancytreeNode
                                                                                                                                                                                                                                        widget: any

                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                        • Activate node with a given key and fire focus and activate events. A previously activated node will be deactivated. If activeVisible option is set, all parents will be expanded as necessary. Pass key = false, to deactivate the current node only.

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          • key: string | boolean

                                                                                                                                                                                                                                          Returns FancytreeNode

                                                                                                                                                                                                                                          activate node (null, if not found)

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                        • [ext-clones] Replace a refKey with a new one.

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          • oldRefKey: string
                                                                                                                                                                                                                                          • newRefKey: string

                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                        • [ext-clones] Replace a refKey with a new one.

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          • oldRefKey: string
                                                                                                                                                                                                                                          • newRefKey: string

                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                        • [ext-persist] Remove persistence cookies of the given type(s). Called like $("#tree").fancytree("getTree").clearCookies("active expanded focus selected");

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                        • Temporarily suppress rendering to improve performance on bulk-updates.

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          • enabled: boolean

                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                          previous status

                                                                                                                                                                                                                                          2.19

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                        • Generate INPUT elements that can be submitted with html forms. In selectMode 3 only the topmost selected nodes are considered.

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          • Optionalselected: boolean
                                                                                                                                                                                                                                          • Optionalactive: boolean

                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                        • Generate INPUT elements that can be submitted with html forms. In selectMode 3 only the topmost selected nodes are considered.

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          • Optionalselected: boolean
                                                                                                                                                                                                                                          • Optionalactive: boolean

                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                        Returns FancytreeNode

                                                                                                                                                                                                                                        • [ext-clones] Return all nodes with a given refKey (null if not found).

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                        Returns FancytreeNode

                                                                                                                                                                                                                                        • Return an array of selected nodes.

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                        Returns FancytreeNode[]

                                                                                                                                                                                                                                        • Make sure that a node with a given ID is loaded, by traversing - and loading - its parents. This method is ment for lazy hierarchies. A callback is executed for every node as we go.

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                        Returns FancytreeNode[]

                                                                                                                                                                                                                                        • Make sure that a node with a given ID is loaded, by traversing - and loading - its parents. This method is ment for lazy hierarchies. A callback is executed for every node as we go.

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          • keyPathList: string[]

                                                                                                                                                                                                                                            one or more key paths (e.g. '/3/2_1/7')

                                                                                                                                                                                                                                          • callback: (node: FancytreeNode, status: string) => void

                                                                                                                                                                                                                                            callback(node, status) is called for every visited node ('loading', 'loaded', 'ok', 'error')

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                          Returns JQueryPromise<any>

                                                                                                                                                                                                                                        • Make sure that a node with a given ID is loaded, by traversing - and loading - its parents. This method is ment for lazy hierarchies. A callback is executed for every node as we go.

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                        Returns JQueryPromise<any>

                                                                                                                                                                                                                                      • Make sure that a node with a given ID is loaded, by traversing - and loading - its parents. This method is ment for lazy hierarchies. A callback is executed for every node as we go.

                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                        • keyPath: string

                                                                                                                                                                                                                                          a key path (e.g. '/3/2_1/7')

                                                                                                                                                                                                                                        • callback: (node: FancytreeNode, status: string) => void

                                                                                                                                                                                                                                          callback(node, status) is called for every visited node ('loading', 'loaded', 'ok', 'error')

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                        Returns JQueryPromise<any>

                                                                                                                                                                                                                                        • Reload tree from source and return a promise.

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                        Returns JQueryPromise<any>

                                                                                                                                                                                                                                        • Render tree (i.e. create DOM elements for all top-level nodes).

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                        Returns JQueryPromise<any>

                                                                                                                                                                                                                                        • Render tree (i.e. create DOM elements for all top-level nodes).

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          • Optionalforce: boolean

                                                                                                                                                                                                                                            create DOM elements, even is parent is collapsed (default = false)

                                                                                                                                                                                                                                          • Optionaldeep: boolean

                                                                                                                                                                                                                                            (default = false)

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                        • Return all nodes as nested list of NodeData.

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                        • Return all nodes as nested list of NodeData.

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          • OptionalincludeRoot: boolean

                                                                                                                                                                                                                                            Returns the hidden system root node (and its children) (default = false)

                                                                                                                                                                                                                                          • Optionalcallback: (node: FancytreeNode) => void

                                                                                                                                                                                                                                            Called for every node

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                          Returns any

                                                                                                                                                                                                                                        • Call fn(node) for all nodes.

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                        Returns any

                                                                                                                                                                                                                                        • Call fn(node) for all nodes.

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          • fn: (node: FancytreeNode) => any

                                                                                                                                                                                                                                            the callback function. Return false to stop iteration, return "skip" to skip this node and children only.

                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                          false, if the iterator was stopped.

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeEvents.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.FancytreeEvents.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeEvents.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.FancytreeEvents.html index 21b382344..97d259167 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeEvents.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.FancytreeEvents.html @@ -1,5 +1,5 @@ FancytreeEvents | trilium
                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                          Interface FancytreeEvents

                                                                                                                                                                                                                                          The this context of any event function is set to tree's the HTMLDivElement

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          interface FancytreeEvents {
                                                                                                                                                                                                                                              rtl?: boolean;
                                                                                                                                                                                                                                              activate(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              beforeActivate(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                              beforeExpand(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                              beforeSelect(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                              blur(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              blurTree(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              click(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                              collapse(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              create(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              createNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              dblclick(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                              deactivate(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              expand(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              focus(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              focusTree(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              init(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              keydown(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                              keypress(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              lazyLoad(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              loadChildren(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              loadError(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                              postProcess(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              removeNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              renderColumns(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              renderNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              renderTitle(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              restore(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              select(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                          rtl? +
                                                                                                                                                                                                                                          interface FancytreeEvents {
                                                                                                                                                                                                                                              rtl?: boolean;
                                                                                                                                                                                                                                              activate(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              beforeActivate(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                              beforeExpand(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                              beforeSelect(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                              blur(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              blurTree(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              click(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                              collapse(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              create(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              createNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              dblclick(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                              deactivate(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              expand(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              focus(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              focusTree(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              init(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              keydown(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                              keypress(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              lazyLoad(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              loadChildren(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              loadError(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                              postProcess(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              removeNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              renderColumns(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              renderNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              renderTitle(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              restore(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                              select(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                          rtl?

                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                          activate? beforeActivate? beforeExpand? @@ -29,32 +29,32 @@ restore? select?

                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                          rtl?: boolean

                                                                                                                                                                                                                                          Enable RTL version, default is false

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeNode.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.FancytreeNode.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeNode.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.FancytreeNode.html index 6ec1eb479..af79f1304 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeNode.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.FancytreeNode.html @@ -1,5 +1,5 @@ FancytreeNode | trilium
                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Interface FancytreeNode

                                                                                                                                                                                                                                            A FancytreeNode represents the hierarchical data model and operations.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            interface FancytreeNode {
                                                                                                                                                                                                                                                children: FancytreeNode[];
                                                                                                                                                                                                                                                data: any;
                                                                                                                                                                                                                                                expanded: boolean;
                                                                                                                                                                                                                                                extraClasses: string;
                                                                                                                                                                                                                                                folder: boolean;
                                                                                                                                                                                                                                                icon: string;
                                                                                                                                                                                                                                                key: string;
                                                                                                                                                                                                                                                lazy: boolean;
                                                                                                                                                                                                                                                parent: FancytreeNode;
                                                                                                                                                                                                                                                span: HTMLElement;
                                                                                                                                                                                                                                                statusNodeType: string;
                                                                                                                                                                                                                                                title: string;
                                                                                                                                                                                                                                                tooltip: string;
                                                                                                                                                                                                                                                tr: HTMLTableRowElement;
                                                                                                                                                                                                                                                tree: Fancytree;
                                                                                                                                                                                                                                                unselectable?: boolean;
                                                                                                                                                                                                                                                unselectableIgnore?: boolean;
                                                                                                                                                                                                                                                unselectableStatus?: boolean;
                                                                                                                                                                                                                                                addChildren(
                                                                                                                                                                                                                                                    children: NodeData[],
                                                                                                                                                                                                                                                    insertBefore?: FancytreeNode,
                                                                                                                                                                                                                                                ): FancytreeNode;
                                                                                                                                                                                                                                                addChildren(children: NodeData[], insertBefore?: string): FancytreeNode;
                                                                                                                                                                                                                                                addChildren(children: NodeData[], insertBefore?: number): FancytreeNode;
                                                                                                                                                                                                                                                addChildren(child: NodeData, insertBefore?: FancytreeNode): FancytreeNode;
                                                                                                                                                                                                                                                addChildren(child: NodeData, insertBefore?: string): FancytreeNode;
                                                                                                                                                                                                                                                addChildren(child: NodeData, insertBefore?: number): FancytreeNode;
                                                                                                                                                                                                                                                addClass(className: string): void;
                                                                                                                                                                                                                                                addNode(node: NodeData, mode?: string): FancytreeNode;
                                                                                                                                                                                                                                                applyPatch(patch: NodePatch): JQueryPromise<any>;
                                                                                                                                                                                                                                                collapseSiblings(): JQueryPromise<any>;
                                                                                                                                                                                                                                                copyTo(
                                                                                                                                                                                                                                                    node: FancytreeNode,
                                                                                                                                                                                                                                                    mode?: string,
                                                                                                                                                                                                                                                    map?: (node: NodeData) => void,
                                                                                                                                                                                                                                                ): FancytreeNode;
                                                                                                                                                                                                                                                countChildren(deep?: boolean): number;
                                                                                                                                                                                                                                                debug(msg: any): void;
                                                                                                                                                                                                                                                editCreateNode(mode?: string, init?: Object): void;
                                                                                                                                                                                                                                                editEnd(applyChanges: boolean): void;
                                                                                                                                                                                                                                                editStart(): void;
                                                                                                                                                                                                                                                findAll(match: string): FancytreeNode[];
                                                                                                                                                                                                                                                findAll(match: (node: FancytreeNode) => boolean): FancytreeNode[];
                                                                                                                                                                                                                                                findFirst(match: string): FancytreeNode;
                                                                                                                                                                                                                                                findFirst(match: (node: FancytreeNode) => boolean): FancytreeNode;
                                                                                                                                                                                                                                                fixSelection3AfterClick(): void;
                                                                                                                                                                                                                                                fixSelection3FromEndNodes(): void;
                                                                                                                                                                                                                                                fromDict(dict: NodeData): void;
                                                                                                                                                                                                                                                getChildren(): FancytreeNode[];
                                                                                                                                                                                                                                                getCloneList(includeSelf?: boolean): FancytreeNode[];
                                                                                                                                                                                                                                                getFirstChild(): FancytreeNode;
                                                                                                                                                                                                                                                getIndex(): number;
                                                                                                                                                                                                                                                getIndexHier(): string;
                                                                                                                                                                                                                                                getKeyPath(excludeSelf: boolean): string;
                                                                                                                                                                                                                                                getLastChild(): FancytreeNode;
                                                                                                                                                                                                                                                getLevel(): number;
                                                                                                                                                                                                                                                getNextSibling(): FancytreeNode;
                                                                                                                                                                                                                                                getParent(): FancytreeNode;
                                                                                                                                                                                                                                                getParentList(includeRoot: boolean, includeSelf: boolean): FancytreeNode[];
                                                                                                                                                                                                                                                getPrevSibling(): FancytreeNode;
                                                                                                                                                                                                                                                hasChildren(): boolean;
                                                                                                                                                                                                                                                hasFocus(): boolean;
                                                                                                                                                                                                                                                info(msg: string): void;
                                                                                                                                                                                                                                                isActive(): boolean;
                                                                                                                                                                                                                                                isChildOf(otherNode: FancytreeNode): boolean;
                                                                                                                                                                                                                                                isClone(): boolean;
                                                                                                                                                                                                                                                isDescendantOf(otherNode: FancytreeNode): boolean;
                                                                                                                                                                                                                                                isEditing(): boolean;
                                                                                                                                                                                                                                                isExpanded(): boolean;
                                                                                                                                                                                                                                                isFirstSibling(): boolean;
                                                                                                                                                                                                                                                isFolder(): boolean;
                                                                                                                                                                                                                                                isLastSibling(): boolean;
                                                                                                                                                                                                                                                isLazy(): boolean;
                                                                                                                                                                                                                                                isLoaded(): boolean;
                                                                                                                                                                                                                                                isLoading(): boolean;
                                                                                                                                                                                                                                                isRootNode(): boolean;
                                                                                                                                                                                                                                                isSelected(): boolean;
                                                                                                                                                                                                                                                isStatusNode(): boolean;
                                                                                                                                                                                                                                                isTopLevel(): boolean;
                                                                                                                                                                                                                                                isUndefined(): boolean;
                                                                                                                                                                                                                                                isVisible(): boolean;
                                                                                                                                                                                                                                                load(forceReload?: boolean): JQueryPromise<any>;
                                                                                                                                                                                                                                                makeVisible(opts?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                moveTo(
                                                                                                                                                                                                                                                    targetNode: FancytreeNode,
                                                                                                                                                                                                                                                    mode: string,
                                                                                                                                                                                                                                                    map?: (node: FancytreeNode) => void,
                                                                                                                                                                                                                                                ): void;
                                                                                                                                                                                                                                                navigate(where: number, activate?: boolean): JQueryPromise<any>;
                                                                                                                                                                                                                                                remove(): void;
                                                                                                                                                                                                                                                removeChild(childNode: FancytreeNode): void;
                                                                                                                                                                                                                                                removeChildren(): void;
                                                                                                                                                                                                                                                removeClass(className: string): void;
                                                                                                                                                                                                                                                render(force?: boolean, deep?: boolean): void;
                                                                                                                                                                                                                                                renderStatus(): void;
                                                                                                                                                                                                                                                renderTitle(): void;
                                                                                                                                                                                                                                                reRegister(key: string, refKey: string): boolean;
                                                                                                                                                                                                                                                resetLazy(): void;
                                                                                                                                                                                                                                                scheduleAction(mode: string, ms: number): void;
                                                                                                                                                                                                                                                scrollIntoView(effects?: boolean, options?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                scrollIntoView(effects?: Object, options?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                setActive(flag?: boolean, opts?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                setExpanded(flag?: boolean, opts?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                setFocus(flag?: boolean): void;
                                                                                                                                                                                                                                                setSelected(flag?: boolean): void;
                                                                                                                                                                                                                                                setStatus(status: string, message?: string, details?: string): void;
                                                                                                                                                                                                                                                setTitle(title: string): void;
                                                                                                                                                                                                                                                sortChildren(
                                                                                                                                                                                                                                                    cmp?: (a: FancytreeNode, b: FancytreeNode) => number,
                                                                                                                                                                                                                                                    deep?: boolean,
                                                                                                                                                                                                                                                ): void;
                                                                                                                                                                                                                                                toDict(recursive?: boolean, callback?: (dict: NodeData) => void): NodeData;
                                                                                                                                                                                                                                                toggleClass(className: string, flag?: boolean): boolean;
                                                                                                                                                                                                                                                toggleExpanded(): void;
                                                                                                                                                                                                                                                toggleSelected(): void;
                                                                                                                                                                                                                                                visit(fn: (node: FancytreeNode) => any, includeSelf?: boolean): boolean;
                                                                                                                                                                                                                                                visitAndLoad(
                                                                                                                                                                                                                                                    fn: (node: FancytreeNode) => any,
                                                                                                                                                                                                                                                    includeSelf?: boolean,
                                                                                                                                                                                                                                                ): JQueryPromise<any>;
                                                                                                                                                                                                                                                visitParents(
                                                                                                                                                                                                                                                    fn: (node: FancytreeNode) => any,
                                                                                                                                                                                                                                                    includeSelf?: boolean,
                                                                                                                                                                                                                                                ): boolean;
                                                                                                                                                                                                                                                warn(msg: any): void;
                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                            children +
                                                                                                                                                                                                                                            interface FancytreeNode {
                                                                                                                                                                                                                                                children: FancytreeNode[];
                                                                                                                                                                                                                                                data: any;
                                                                                                                                                                                                                                                expanded: boolean;
                                                                                                                                                                                                                                                extraClasses: string;
                                                                                                                                                                                                                                                folder: boolean;
                                                                                                                                                                                                                                                icon: string;
                                                                                                                                                                                                                                                key: string;
                                                                                                                                                                                                                                                lazy: boolean;
                                                                                                                                                                                                                                                parent: FancytreeNode;
                                                                                                                                                                                                                                                span: HTMLElement;
                                                                                                                                                                                                                                                statusNodeType: string;
                                                                                                                                                                                                                                                title: string;
                                                                                                                                                                                                                                                tooltip: string;
                                                                                                                                                                                                                                                tr: HTMLTableRowElement;
                                                                                                                                                                                                                                                tree: Fancytree;
                                                                                                                                                                                                                                                unselectable?: boolean;
                                                                                                                                                                                                                                                unselectableIgnore?: boolean;
                                                                                                                                                                                                                                                unselectableStatus?: boolean;
                                                                                                                                                                                                                                                addChildren(
                                                                                                                                                                                                                                                    children: NodeData[],
                                                                                                                                                                                                                                                    insertBefore?: FancytreeNode,
                                                                                                                                                                                                                                                ): FancytreeNode;
                                                                                                                                                                                                                                                addChildren(children: NodeData[], insertBefore?: string): FancytreeNode;
                                                                                                                                                                                                                                                addChildren(children: NodeData[], insertBefore?: number): FancytreeNode;
                                                                                                                                                                                                                                                addChildren(child: NodeData, insertBefore?: FancytreeNode): FancytreeNode;
                                                                                                                                                                                                                                                addChildren(child: NodeData, insertBefore?: string): FancytreeNode;
                                                                                                                                                                                                                                                addChildren(child: NodeData, insertBefore?: number): FancytreeNode;
                                                                                                                                                                                                                                                addClass(className: string): void;
                                                                                                                                                                                                                                                addNode(node: NodeData, mode?: string): FancytreeNode;
                                                                                                                                                                                                                                                applyPatch(patch: NodePatch): JQueryPromise<any>;
                                                                                                                                                                                                                                                collapseSiblings(): JQueryPromise<any>;
                                                                                                                                                                                                                                                copyTo(
                                                                                                                                                                                                                                                    node: FancytreeNode,
                                                                                                                                                                                                                                                    mode?: string,
                                                                                                                                                                                                                                                    map?: (node: NodeData) => void,
                                                                                                                                                                                                                                                ): FancytreeNode;
                                                                                                                                                                                                                                                countChildren(deep?: boolean): number;
                                                                                                                                                                                                                                                debug(msg: any): void;
                                                                                                                                                                                                                                                editCreateNode(mode?: string, init?: Object): void;
                                                                                                                                                                                                                                                editEnd(applyChanges: boolean): void;
                                                                                                                                                                                                                                                editStart(): void;
                                                                                                                                                                                                                                                findAll(match: string): FancytreeNode[];
                                                                                                                                                                                                                                                findAll(match: (node: FancytreeNode) => boolean): FancytreeNode[];
                                                                                                                                                                                                                                                findFirst(match: string): FancytreeNode;
                                                                                                                                                                                                                                                findFirst(match: (node: FancytreeNode) => boolean): FancytreeNode;
                                                                                                                                                                                                                                                fixSelection3AfterClick(): void;
                                                                                                                                                                                                                                                fixSelection3FromEndNodes(): void;
                                                                                                                                                                                                                                                fromDict(dict: NodeData): void;
                                                                                                                                                                                                                                                getChildren(): FancytreeNode[];
                                                                                                                                                                                                                                                getCloneList(includeSelf?: boolean): FancytreeNode[];
                                                                                                                                                                                                                                                getFirstChild(): FancytreeNode;
                                                                                                                                                                                                                                                getIndex(): number;
                                                                                                                                                                                                                                                getIndexHier(): string;
                                                                                                                                                                                                                                                getKeyPath(excludeSelf: boolean): string;
                                                                                                                                                                                                                                                getLastChild(): FancytreeNode;
                                                                                                                                                                                                                                                getLevel(): number;
                                                                                                                                                                                                                                                getNextSibling(): FancytreeNode;
                                                                                                                                                                                                                                                getParent(): FancytreeNode;
                                                                                                                                                                                                                                                getParentList(includeRoot: boolean, includeSelf: boolean): FancytreeNode[];
                                                                                                                                                                                                                                                getPrevSibling(): FancytreeNode;
                                                                                                                                                                                                                                                hasChildren(): boolean;
                                                                                                                                                                                                                                                hasFocus(): boolean;
                                                                                                                                                                                                                                                info(msg: string): void;
                                                                                                                                                                                                                                                isActive(): boolean;
                                                                                                                                                                                                                                                isChildOf(otherNode: FancytreeNode): boolean;
                                                                                                                                                                                                                                                isClone(): boolean;
                                                                                                                                                                                                                                                isDescendantOf(otherNode: FancytreeNode): boolean;
                                                                                                                                                                                                                                                isEditing(): boolean;
                                                                                                                                                                                                                                                isExpanded(): boolean;
                                                                                                                                                                                                                                                isFirstSibling(): boolean;
                                                                                                                                                                                                                                                isFolder(): boolean;
                                                                                                                                                                                                                                                isLastSibling(): boolean;
                                                                                                                                                                                                                                                isLazy(): boolean;
                                                                                                                                                                                                                                                isLoaded(): boolean;
                                                                                                                                                                                                                                                isLoading(): boolean;
                                                                                                                                                                                                                                                isRootNode(): boolean;
                                                                                                                                                                                                                                                isSelected(): boolean;
                                                                                                                                                                                                                                                isStatusNode(): boolean;
                                                                                                                                                                                                                                                isTopLevel(): boolean;
                                                                                                                                                                                                                                                isUndefined(): boolean;
                                                                                                                                                                                                                                                isVisible(): boolean;
                                                                                                                                                                                                                                                load(forceReload?: boolean): JQueryPromise<any>;
                                                                                                                                                                                                                                                makeVisible(opts?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                moveTo(
                                                                                                                                                                                                                                                    targetNode: FancytreeNode,
                                                                                                                                                                                                                                                    mode: string,
                                                                                                                                                                                                                                                    map?: (node: FancytreeNode) => void,
                                                                                                                                                                                                                                                ): void;
                                                                                                                                                                                                                                                navigate(where: number, activate?: boolean): JQueryPromise<any>;
                                                                                                                                                                                                                                                remove(): void;
                                                                                                                                                                                                                                                removeChild(childNode: FancytreeNode): void;
                                                                                                                                                                                                                                                removeChildren(): void;
                                                                                                                                                                                                                                                removeClass(className: string): void;
                                                                                                                                                                                                                                                render(force?: boolean, deep?: boolean): void;
                                                                                                                                                                                                                                                renderStatus(): void;
                                                                                                                                                                                                                                                renderTitle(): void;
                                                                                                                                                                                                                                                reRegister(key: string, refKey: string): boolean;
                                                                                                                                                                                                                                                resetLazy(): void;
                                                                                                                                                                                                                                                scheduleAction(mode: string, ms: number): void;
                                                                                                                                                                                                                                                scrollIntoView(effects?: boolean, options?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                scrollIntoView(effects?: Object, options?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                setActive(flag?: boolean, opts?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                setExpanded(flag?: boolean, opts?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                setFocus(flag?: boolean): void;
                                                                                                                                                                                                                                                setSelected(flag?: boolean): void;
                                                                                                                                                                                                                                                setStatus(status: string, message?: string, details?: string): void;
                                                                                                                                                                                                                                                setTitle(title: string): void;
                                                                                                                                                                                                                                                sortChildren(
                                                                                                                                                                                                                                                    cmp?: (a: FancytreeNode, b: FancytreeNode) => number,
                                                                                                                                                                                                                                                    deep?: boolean,
                                                                                                                                                                                                                                                ): void;
                                                                                                                                                                                                                                                toDict(recursive?: boolean, callback?: (dict: NodeData) => void): NodeData;
                                                                                                                                                                                                                                                toggleClass(className: string, flag?: boolean): boolean;
                                                                                                                                                                                                                                                toggleExpanded(): void;
                                                                                                                                                                                                                                                toggleSelected(): void;
                                                                                                                                                                                                                                                visit(fn: (node: FancytreeNode) => any, includeSelf?: boolean): boolean;
                                                                                                                                                                                                                                                visitAndLoad(
                                                                                                                                                                                                                                                    fn: (node: FancytreeNode) => any,
                                                                                                                                                                                                                                                    includeSelf?: boolean,
                                                                                                                                                                                                                                                ): JQueryPromise<any>;
                                                                                                                                                                                                                                                visitParents(
                                                                                                                                                                                                                                                    fn: (node: FancytreeNode) => any,
                                                                                                                                                                                                                                                    includeSelf?: boolean,
                                                                                                                                                                                                                                                ): boolean;
                                                                                                                                                                                                                                                warn(msg: any): void;
                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                            children data expanded extraClasses @@ -97,180 +97,180 @@ visitParents warn

                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                            children: FancytreeNode[]

                                                                                                                                                                                                                                            Array of child nodes. For lazy nodes, null or undefined means 'not yet loaded'. Use an empty array to define a node that has no children.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            data: any

                                                                                                                                                                                                                                            Contains all extra data that was passed on node creation

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            expanded: boolean

                                                                                                                                                                                                                                            Use isExpanded(), setExpanded() to access this property.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            extraClasses: string

                                                                                                                                                                                                                                            Addtional CSS classes, added to the node's <span>.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            folder: boolean

                                                                                                                                                                                                                                            Folder nodes have different default icons and click behavior. Note: Also non-folders may have children.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            icon: string

                                                                                                                                                                                                                                            Icon of the tree node.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            key: string

                                                                                                                                                                                                                                            Node id (must be unique inside the tree)

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            lazy: boolean

                                                                                                                                                                                                                                            True if this node is loaded on demand, i.e. on first expansion.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            parent: FancytreeNode

                                                                                                                                                                                                                                            The parent node

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            span: HTMLElement

                                                                                                                                                                                                                                            Outer element of single nodes

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            statusNodeType: string

                                                                                                                                                                                                                                            null or type of temporarily generated system node like 'loading', or 'error'.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            title: string

                                                                                                                                                                                                                                            Display name (may contain HTML)

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            tooltip: string

                                                                                                                                                                                                                                            Alternative description used as hover banner

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            tr: HTMLTableRowElement

                                                                                                                                                                                                                                            Outer element of single nodes for table extension

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            tree: Fancytree

                                                                                                                                                                                                                                            The tree instance

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            unselectable?: boolean
                                                                                                                                                                                                                                            unselectableIgnore?: boolean
                                                                                                                                                                                                                                            unselectableStatus?: boolean

                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                            data: any

                                                                                                                                                                                                                                            Contains all extra data that was passed on node creation

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            expanded: boolean

                                                                                                                                                                                                                                            Use isExpanded(), setExpanded() to access this property.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            extraClasses: string

                                                                                                                                                                                                                                            Addtional CSS classes, added to the node's <span>.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            folder: boolean

                                                                                                                                                                                                                                            Folder nodes have different default icons and click behavior. Note: Also non-folders may have children.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            icon: string

                                                                                                                                                                                                                                            Icon of the tree node.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            key: string

                                                                                                                                                                                                                                            Node id (must be unique inside the tree)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            lazy: boolean

                                                                                                                                                                                                                                            True if this node is loaded on demand, i.e. on first expansion.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            parent: FancytreeNode

                                                                                                                                                                                                                                            The parent node

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            span: HTMLElement

                                                                                                                                                                                                                                            Outer element of single nodes

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            statusNodeType: string

                                                                                                                                                                                                                                            null or type of temporarily generated system node like 'loading', or 'error'.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            title: string

                                                                                                                                                                                                                                            Display name (may contain HTML)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            tooltip: string

                                                                                                                                                                                                                                            Alternative description used as hover banner

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            tr: HTMLTableRowElement

                                                                                                                                                                                                                                            Outer element of single nodes for table extension

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            tree: Fancytree

                                                                                                                                                                                                                                            The tree instance

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            unselectable?: boolean
                                                                                                                                                                                                                                            unselectableIgnore?: boolean
                                                                                                                                                                                                                                            unselectableStatus?: boolean

                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                            • Append or prepend a node, or append a child node. This a convenience function that calls addChildren()

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                            • Count direct and indirect children.

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • Optionaldeep: boolean

                                                                                                                                                                                                                                                pass 'false' to only count direct children. (default=true)

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                              Returns number

                                                                                                                                                                                                                                            • [ext-edit] Create a new child or sibling node and start edit mode.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns number

                                                                                                                                                                                                                                            • [ext-edit] Create a new child or sibling node and start edit mode.

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • Optionalmode: string

                                                                                                                                                                                                                                                'before', 'after', or 'child' (default='child')

                                                                                                                                                                                                                                              • Optionalinit: Object

                                                                                                                                                                                                                                                NodeData (or simple title string)

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                            • [ext-edit] Stop inline editing.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                            • [ext-edit] Stop inline editing.

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • applyChanges: boolean

                                                                                                                                                                                                                                                false: cancel edit, true: save (if modified)

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                            • Find all nodes that contain match in the title.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                            Returns FancytreeNode[]

                                                                                                                                                                                                                                          • Find all nodes that contain match in the title.

                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                            • match: (node: FancytreeNode) => boolean

                                                                                                                                                                                                                                              a function that returns true if a node is matched.

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                            Returns FancytreeNode[]

                                                                                                                                                                                                                                            • Find first node that contains match in the title (not including self).

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns FancytreeNode[]

                                                                                                                                                                                                                                            Returns FancytreeNode

                                                                                                                                                                                                                                          • Find first node that contains match in the title (not including self).

                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                            • match: (node: FancytreeNode) => boolean

                                                                                                                                                                                                                                              a function that returns true if a node is matched.

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                            Returns FancytreeNode

                                                                                                                                                                                                                                            • Fix selection status, after this node was (de)selected in multi-hier mode. This includes (de)selecting all children.

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                            • Fix selection status for multi-hier mode. Only end-nodes are considered to update the descendants branch and parents. Should be called after this node has loaded new children or after children have been modified using the API.

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                            • Return the parent keys separated by options.keyPathSeparator, e.g. "id_1/id_17/id_32".

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • excludeSelf: boolean

                                                                                                                                                                                                                                              Returns string

                                                                                                                                                                                                                                            • Return an array of all parent nodes (top-down).

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns FancytreeNode

                                                                                                                                                                                                                                            • Fix selection status, after this node was (de)selected in multi-hier mode. This includes (de)selecting all children.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                            • Fix selection status for multi-hier mode. Only end-nodes are considered to update the descendants branch and parents. Should be called after this node has loaded new children or after children have been modified using the API.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                            • Return the parent keys separated by options.keyPathSeparator, e.g. "id_1/id_17/id_32".

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • excludeSelf: boolean

                                                                                                                                                                                                                                              Returns string

                                                                                                                                                                                                                                            • Return an array of all parent nodes (top-down).

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • includeRoot: boolean

                                                                                                                                                                                                                                                Include the invisible system root node. (default=false)

                                                                                                                                                                                                                                              • includeSelf: boolean

                                                                                                                                                                                                                                                Include the node itself (default=false).

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                              Returns FancytreeNode[]

                                                                                                                                                                                                                                            • Return true if node has children. Return undefined if not sure, i.e. the node is lazy and not yet loaded).

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                            • Return true if this node is a temporarily generated system node like 'loading', or 'error' (node.statusNodeType contains the type).

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                            • Return true if all parent nodes are expanded. Note: this does not check whether the node is scrolled into the visible part of the screen.

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                            • Load all children of a lazy node if neccessary. The expanded state is maintained.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns FancytreeNode[]

                                                                                                                                                                                                                                            • Return true if node has children. Return undefined if not sure, i.e. the node is lazy and not yet loaded).

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                            • Return true if this node is a temporarily generated system node like 'loading', or 'error' (node.statusNodeType contains the type).

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                            • Return true if all parent nodes are expanded. Note: this does not check whether the node is scrolled into the visible part of the screen.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                            • Expand all parents and optionally scroll into visible area as neccessary. Promise is resolved, when lazy loading and animations are done.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns JQueryPromise<any>

                                                                                                                                                                                                                                            • Expand all parents and optionally scroll into visible area as neccessary. Promise is resolved, when lazy loading and animations are done.

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • Optionalopts: Object

                                                                                                                                                                                                                                                passed to setExpanded(). Defaults to {noAnimation: false, noEvents: false, scrollIntoView: true}

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                              Returns JQueryPromise<any>

                                                                                                                                                                                                                                            • Move this node to targetNode.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns JQueryPromise<any>

                                                                                                                                                                                                                                            • Move this node to targetNode.

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • targetNode: FancytreeNode
                                                                                                                                                                                                                                              • mode: string

                                                                                                                                                                                                                                                'child': append this node as last child of targetNode. This is the default. To be compatble with the D'n'd hitMode, we also accept 'over'. 'before': add this node as sibling before targetNode. 'after': add this node as sibling after targetNode.

                                                                                                                                                                                                                                              • Optionalmap: (node: FancytreeNode) => void

                                                                                                                                                                                                                                                optional callback(FancytreeNode) to allow modifcations

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                            • Set focus relative to this node and optionally activate.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                            • Set focus relative to this node and optionally activate.

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • where: number

                                                                                                                                                                                                                                                The keyCode that would normally trigger this move, e.g. $.ui.keyCode.LEFT would collapse the node if it is expanded or move to the parent oterwise.

                                                                                                                                                                                                                                              • Optionalactivate: boolean

                                                                                                                                                                                                                                                (default=true)

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                              Returns JQueryPromise<any>

                                                                                                                                                                                                                                            • Remove all child nodes and descendents. This converts the node into a leaf. +

                                                                                                                                                                                                                                            Returns JQueryPromise<any>

                                                                                                                                                                                                                                            • Remove all child nodes and descendents. This converts the node into a leaf. If this was a lazy node, it is still considered 'loaded'; call node.resetLazy() in order to trigger lazyLoad on next expand.

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                            • This method renders and updates all HTML markup that is required to display this node in its current state.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                            • This method renders and updates all HTML markup that is required to display this node in its current state.

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • Optionalforce: boolean

                                                                                                                                                                                                                                                re-render, even if html markup was already created

                                                                                                                                                                                                                                              • Optionaldeep: boolean

                                                                                                                                                                                                                                                also render all descendants, even if parent is collapsed

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                            • [ext-clones] Update key and/or refKey for an existing node.

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • key: string
                                                                                                                                                                                                                                              • refKey: string

                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                            • Schedule activity for delayed execution (cancel any pending request). scheduleAction('cancel') will only cancel a pending request (if any).

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • mode: string
                                                                                                                                                                                                                                              • ms: number

                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                            • [ext-clones] Update key and/or refKey for an existing node.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • key: string
                                                                                                                                                                                                                                              • refKey: string

                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                            • Schedule activity for delayed execution (cancel any pending request). scheduleAction('cancel') will only cancel a pending request (if any).

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • mode: string
                                                                                                                                                                                                                                              • ms: number

                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                            • Set keyboard focus to this node.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns JQueryPromise<any>

                                                                                                                                                                                                                                            • Select this node, i.e. check the checkbox.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                            • Mark a lazy node as 'error', 'loading', or 'ok'.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                            • Mark a lazy node as 'error', 'loading', or 'ok'.

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • status: string

                                                                                                                                                                                                                                                'error', 'ok'

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                              • Optionalmessage: string
                                                                                                                                                                                                                                              • Optionaldetails: string

                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                            • Sort child list by title.

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                            • Optionalmessage: string
                                                                                                                                                                                                                                            • Optionaldetails: string

                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                            • Convert node (or whole branch) into a plain object. The result is compatible with node.addChildren().

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                            • Convert node (or whole branch) into a plain object. The result is compatible with node.addChildren().

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • Optionalrecursive: boolean

                                                                                                                                                                                                                                                include child nodes.

                                                                                                                                                                                                                                              • Optionalcallback: (dict: NodeData) => void

                                                                                                                                                                                                                                                callback(dict) is called for every node, in order to allow modifications

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                              Returns NodeData

                                                                                                                                                                                                                                            • Set, clear, or toggle class of node's span tag and .extraClasses.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                            Returns NodeData

                                                                                                                                                                                                                                            • Set, clear, or toggle class of node's span tag and .extraClasses.

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • className: string

                                                                                                                                                                                                                                                class name (separate multiple classes by space)

                                                                                                                                                                                                                                              • Optionalflag: boolean

                                                                                                                                                                                                                                                true/false to add/remove class. If omitted, class is toggled.

                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                              true if a class was added

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                            • Call fn(node) for all child nodes. Stop iteration, if fn() returns false. Skip current branch, if fn() returns "skip". Return false if iteration was stopped.

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • fn: (node: FancytreeNode) => any

                                                                                                                                                                                                                                                the callback function. Return false to stop iteration, return "skip" to skip this node and its children only.

                                                                                                                                                                                                                                              • OptionalincludeSelf: boolean

                                                                                                                                                                                                                                                (default=false)

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                            • Call fn(node) for all child nodes and recursively load lazy children. +

                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                            • Call fn(node) for all child nodes and recursively load lazy children. Note: If you need this method, you probably should consider to review your architecture! Recursivley loading nodes is a perfect way for lazy programmers to flood the server with requests ;-)

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • fn: (node: FancytreeNode) => any

                                                                                                                                                                                                                                                the callback function. Return false to stop iteration, return "skip" to skip this node and its children only.

                                                                                                                                                                                                                                              • OptionalincludeSelf: boolean

                                                                                                                                                                                                                                                (default=false)

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                              Returns JQueryPromise<any>

                                                                                                                                                                                                                                            • Call fn(node) for all parent nodes, bottom-up, including invisible system root. +

                                                                                                                                                                                                                                            Returns JQueryPromise<any>

                                                                                                                                                                                                                                            • Call fn(node) for all parent nodes, bottom-up, including invisible system root. Stop iteration, if fn() returns false. Return false if iteration was stopped.

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • fn: (node: FancytreeNode) => any

                                                                                                                                                                                                                                                the callback function. Return false to stop iteration, return "skip" to skip this node and its children only.

                                                                                                                                                                                                                                              • OptionalincludeSelf: boolean

                                                                                                                                                                                                                                                (default=false)

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                            addChildrenaddClassaddNodeapplyPatchcollapseSiblingscopyTocountChildrendebugeditCreateNodeeditEndeditStartfindAllfindFirstfixSelection3AfterClickfixSelection3FromEndNodesfromDictgetChildrengetCloneListgetFirstChildgetIndexgetIndexHiergetKeyPathgetLastChildgetLevelgetNextSiblinggetParentgetParentListgetPrevSiblinghasChildrenhasFocusinfoisActiveisChildOfisCloneisDescendantOfisEditingisExpandedisFirstSiblingisFolderisLastSiblingisLazyisLoadedisLoadingisRootNodeisSelectedisStatusNodeisTopLevelisUndefinedisVisibleloadmakeVisiblemoveTonavigateremoveremoveChildremoveChildrenremoveClassrenderrenderStatusrenderTitlereRegisterresetLazyscheduleActionscrollIntoViewsetActivesetExpandedsetFocussetSelectedsetStatussetTitlesortChildrentoDicttoggleClasstoggleExpandedtoggleSelectedvisitvisitAndLoadvisitParentswarn
                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                            addChildrenaddClassaddNodeapplyPatchcollapseSiblingscopyTocountChildrendebugeditCreateNodeeditEndeditStartfindAllfindFirstfixSelection3AfterClickfixSelection3FromEndNodesfromDictgetChildrengetCloneListgetFirstChildgetIndexgetIndexHiergetKeyPathgetLastChildgetLevelgetNextSiblinggetParentgetParentListgetPrevSiblinghasChildrenhasFocusinfoisActiveisChildOfisCloneisDescendantOfisEditingisExpandedisFirstSiblingisFolderisLastSiblingisLazyisLoadedisLoadingisRootNodeisSelectedisStatusNodeisTopLevelisUndefinedisVisibleloadmakeVisiblemoveTonavigateremoveremoveChildremoveChildrenremoveClassrenderrenderStatusrenderTitlereRegisterresetLazyscheduleActionscrollIntoViewsetActivesetExpandedsetFocussetSelectedsetStatussetTitlesortChildrentoDicttoggleClasstoggleExpandedtoggleSelectedvisitvisitAndLoadvisitParentswarn
                                                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeOptions.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.FancytreeOptions.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeOptions.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.FancytreeOptions.html index 20368f5ed..5270e59f2 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeOptions.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.FancytreeOptions.html @@ -1,6 +1,6 @@ FancytreeOptions | trilium
                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                              Interface FancytreeOptions

                                                                                                                                                                                                                                              The this context of any event function is set to tree's the HTMLDivElement

                                                                                                                                                                                                                                              interface FancytreeOptions {
                                                                                                                                                                                                                                                  activeVisible?: boolean;
                                                                                                                                                                                                                                                  ajax?: { cache: boolean; dataType: string; type: string };
                                                                                                                                                                                                                                                  aria?: boolean;
                                                                                                                                                                                                                                                  autoActivate?: boolean;
                                                                                                                                                                                                                                                  autoCollapse?: boolean;
                                                                                                                                                                                                                                                  autoScroll?: boolean;
                                                                                                                                                                                                                                                  checkbox?:
                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                      | boolean
                                                                                                                                                                                                                                                      | ((event: JQueryEventObject, data: EventData) => boolean);
                                                                                                                                                                                                                                                  clickFolderMode?: FancytreeClickFolderMode;
                                                                                                                                                                                                                                                  debugLevel?: 0 | 1 | 2 | 3 | 4;
                                                                                                                                                                                                                                                  defaultKey?: (node: FancytreeNode) => string;
                                                                                                                                                                                                                                                  dnd5?: DragAndDrop5;
                                                                                                                                                                                                                                                  enableAspx?: boolean;
                                                                                                                                                                                                                                                  enableTitles?: boolean;
                                                                                                                                                                                                                                                  extensions?: (keyof List)[];
                                                                                                                                                                                                                                                  filter?: Filter;
                                                                                                                                                                                                                                                  focusOnSelect?: boolean;
                                                                                                                                                                                                                                                  generateIds?: boolean;
                                                                                                                                                                                                                                                  icon?: string | boolean;
                                                                                                                                                                                                                                                  idPrefix?: string;
                                                                                                                                                                                                                                                  imagePath?: string;
                                                                                                                                                                                                                                                  keyboard?: boolean;
                                                                                                                                                                                                                                                  keyPathSeparator?: string;
                                                                                                                                                                                                                                                  minExpandLevel?: number;
                                                                                                                                                                                                                                                  quicksearch?: boolean;
                                                                                                                                                                                                                                                  rtl?: boolean;
                                                                                                                                                                                                                                                  scrollOfs?: { bottom: number; top: number };
                                                                                                                                                                                                                                                  scrollParent?: null | JQuery<HTMLElement>;
                                                                                                                                                                                                                                                  selectMode?: FancytreeSelectMode;
                                                                                                                                                                                                                                                  source?: any;
                                                                                                                                                                                                                                                  strings?: TranslationTable;
                                                                                                                                                                                                                                                  tabbable?: boolean;
                                                                                                                                                                                                                                                  table?: Table;
                                                                                                                                                                                                                                                  titlesTabbable?: boolean;
                                                                                                                                                                                                                                                  toggleEffect?: any;
                                                                                                                                                                                                                                                  tooltip?: boolean;
                                                                                                                                                                                                                                                  unselectable?:
                                                                                                                                                                                                                                                      | boolean
                                                                                                                                                                                                                                                      | ((event: JQueryEventObject, data: EventData) => undefined | boolean);
                                                                                                                                                                                                                                                  unselectableIgnore?:
                                                                                                                                                                                                                                                      | boolean
                                                                                                                                                                                                                                                      | ((event: JQueryEventObject, data: EventData) => undefined | boolean);
                                                                                                                                                                                                                                                  unselectableStatus?:
                                                                                                                                                                                                                                                      | boolean
                                                                                                                                                                                                                                                      | ((event: JQueryEventObject, data: EventData) => undefined | boolean);
                                                                                                                                                                                                                                                  activate(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  beforeActivate(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                  beforeExpand(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                  beforeSelect(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                  blur(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  blurTree(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  click(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                  collapse(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  create(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  createNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  dblclick(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                  deactivate(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  expand(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  focus(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  focusTree(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  init(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  keydown(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                  keypress(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  lazyLoad(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  loadChildren(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  loadError(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                  postProcess(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  removeNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  renderColumns(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  renderNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  renderTitle(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  restore(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  select(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                  [extension: string]: any;
                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                              • [extension: string]: any

                                                                                                                                                                                                                                                Options for misc extensions - see docs for typings

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              activeVisible? +
                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              activeVisible? ajax? aria? autoActivate? @@ -67,69 +67,69 @@ restore? select?

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              activeVisible?: boolean

                                                                                                                                                                                                                                              Make sure that the active node is always visible, i.e. its parents are expanded (default: true).

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              ajax?: { cache: boolean; dataType: string; type: string }

                                                                                                                                                                                                                                              Default options for ajax requests.

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              ajax?: { cache: boolean; dataType: string; type: string }

                                                                                                                                                                                                                                              Default options for ajax requests.

                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                              • cache: boolean

                                                                                                                                                                                                                                                false: Append random '_' argument to the request url to prevent caching.

                                                                                                                                                                                                                                              • dataType: string

                                                                                                                                                                                                                                                Default 'json' -> Expect json format and pass json object to callbacks.

                                                                                                                                                                                                                                              • type: string

                                                                                                                                                                                                                                                HTTP Method (default: 'GET')

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                              aria?: boolean

                                                                                                                                                                                                                                              (default: false) Add WAI-ARIA attributes to markup

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              autoActivate?: boolean

                                                                                                                                                                                                                                              Activate a node when focused with the keyboard (default: true)

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              autoCollapse?: boolean

                                                                                                                                                                                                                                              Automatically collapse all siblings, when a node is expanded (default: false).

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              autoScroll?: boolean

                                                                                                                                                                                                                                              Scroll node into visible area, when focused by keyboard (default: false).

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              checkbox?:
                                                                                                                                                                                                                                                  | string
                                                                                                                                                                                                                                                  | boolean
                                                                                                                                                                                                                                                  | ((event: JQueryEventObject, data: EventData) => boolean)

                                                                                                                                                                                                                                              Display checkboxes to allow selection (default: false)

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              clickFolderMode?: FancytreeClickFolderMode

                                                                                                                                                                                                                                              Defines what happens, when the user click a folder node. (default: activate_dblclick_expands)

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              debugLevel?: 0 | 1 | 2 | 3 | 4

                                                                                                                                                                                                                                              0..4 (null: use global setting $.ui.fancytree.debugInfo)

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              defaultKey?: (node: FancytreeNode) => string

                                                                                                                                                                                                                                              callback(node) is called for new nodes without a key. Must return a new unique key. (default null: generates default keys like that: "_" + counter)

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              dnd5?: DragAndDrop5
                                                                                                                                                                                                                                              enableAspx?: boolean

                                                                                                                                                                                                                                              Accept passing ajax data in a property named d (default: true).

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              enableTitles?: boolean

                                                                                                                                                                                                                                              Enable titles (default: false)

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              extensions?: (keyof List)[]

                                                                                                                                                                                                                                              List of active extensions (default: [])

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              filter?: Filter
                                                                                                                                                                                                                                              focusOnSelect?: boolean

                                                                                                                                                                                                                                              Set focus when node is checked by a mouse click (default: false)

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              generateIds?: boolean

                                                                                                                                                                                                                                              Add id="..." to node markup (default: true).

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              icon?: string | boolean

                                                                                                                                                                                                                                              Node icon url, if only filename, please use imagePath to set the path

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              idPrefix?: string

                                                                                                                                                                                                                                              Prefix (default: "ft_")

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              imagePath?: string

                                                                                                                                                                                                                                              Path to a folder containing icons (default: null, using 'skin/' subdirectory).

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              keyboard?: boolean

                                                                                                                                                                                                                                              Support keyboard navigation (default: true).

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              keyPathSeparator?: string

                                                                                                                                                                                                                                              (default: "/")

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              minExpandLevel?: number

                                                                                                                                                                                                                                              2: top-level nodes are not collapsible (default: 1)

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              quicksearch?: boolean

                                                                                                                                                                                                                                              navigate to next node by typing the first letters (default: false)

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              rtl?: boolean

                                                                                                                                                                                                                                              Right to left mode (default: false)

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              scrollOfs?: { bottom: number; top: number }

                                                                                                                                                                                                                                              optional margins for node.scrollIntoView() (default: {top: 0, bottom: 0})

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              scrollParent?: null | JQuery<HTMLElement>

                                                                                                                                                                                                                                              scrollable container for node.scrollIntoView() (default: $container)

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              selectMode?: FancytreeSelectMode

                                                                                                                                                                                                                                              default: multi_hier

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              source?: any

                                                                                                                                                                                                                                              Used to Initialize the tree.

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              strings?: TranslationTable

                                                                                                                                                                                                                                              Translation table

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              tabbable?: boolean

                                                                                                                                                                                                                                              Add tabindex='0' to container, so tree can be reached using TAB

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              table?: Table
                                                                                                                                                                                                                                              titlesTabbable?: boolean

                                                                                                                                                                                                                                              Add tabindex='0' to node title span, so it can receive keyboard focus

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              toggleEffect?: any

                                                                                                                                                                                                                                              Animation options, false:off (default: { effect: "blind", options: {direction: "vertical", scale: "box"}, duration: 200 })

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              tooltip?: boolean

                                                                                                                                                                                                                                              Tooltips

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              unselectable?:
                                                                                                                                                                                                                                                  | boolean
                                                                                                                                                                                                                                                  | ((event: JQueryEventObject, data: EventData) => undefined | boolean)

                                                                                                                                                                                                                                              (dynamic Option)Prevent (de-)selection using mouse or keyboard.

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              unselectableIgnore?:
                                                                                                                                                                                                                                                  | boolean
                                                                                                                                                                                                                                                  | ((event: JQueryEventObject, data: EventData) => undefined | boolean)

                                                                                                                                                                                                                                              (dynamic Option)Ignore this node when calculating the partsel status of parent nodes in selectMode 3 propagation.

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              unselectableStatus?:
                                                                                                                                                                                                                                                  | boolean
                                                                                                                                                                                                                                                  | ((event: JQueryEventObject, data: EventData) => undefined | boolean)

                                                                                                                                                                                                                                              (dynamic Option)Use this as constant selected value (overriding selectMode 3 propagation).

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              aria?: boolean

                                                                                                                                                                                                                                              (default: false) Add WAI-ARIA attributes to markup

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              autoActivate?: boolean

                                                                                                                                                                                                                                              Activate a node when focused with the keyboard (default: true)

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              autoCollapse?: boolean

                                                                                                                                                                                                                                              Automatically collapse all siblings, when a node is expanded (default: false).

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              autoScroll?: boolean

                                                                                                                                                                                                                                              Scroll node into visible area, when focused by keyboard (default: false).

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              checkbox?:
                                                                                                                                                                                                                                                  | string
                                                                                                                                                                                                                                                  | boolean
                                                                                                                                                                                                                                                  | ((event: JQueryEventObject, data: EventData) => boolean)

                                                                                                                                                                                                                                              Display checkboxes to allow selection (default: false)

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              clickFolderMode?: FancytreeClickFolderMode

                                                                                                                                                                                                                                              Defines what happens, when the user click a folder node. (default: activate_dblclick_expands)

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              debugLevel?: 0 | 1 | 2 | 3 | 4

                                                                                                                                                                                                                                              0..4 (null: use global setting $.ui.fancytree.debugInfo)

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              defaultKey?: (node: FancytreeNode) => string

                                                                                                                                                                                                                                              callback(node) is called for new nodes without a key. Must return a new unique key. (default null: generates default keys like that: "_" + counter)

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              dnd5?: DragAndDrop5
                                                                                                                                                                                                                                              enableAspx?: boolean

                                                                                                                                                                                                                                              Accept passing ajax data in a property named d (default: true).

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              enableTitles?: boolean

                                                                                                                                                                                                                                              Enable titles (default: false)

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              extensions?: (keyof List)[]

                                                                                                                                                                                                                                              List of active extensions (default: [])

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              filter?: Filter
                                                                                                                                                                                                                                              focusOnSelect?: boolean

                                                                                                                                                                                                                                              Set focus when node is checked by a mouse click (default: false)

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              generateIds?: boolean

                                                                                                                                                                                                                                              Add id="..." to node markup (default: true).

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              icon?: string | boolean

                                                                                                                                                                                                                                              Node icon url, if only filename, please use imagePath to set the path

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              idPrefix?: string

                                                                                                                                                                                                                                              Prefix (default: "ft_")

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              imagePath?: string

                                                                                                                                                                                                                                              Path to a folder containing icons (default: null, using 'skin/' subdirectory).

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              keyboard?: boolean

                                                                                                                                                                                                                                              Support keyboard navigation (default: true).

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              keyPathSeparator?: string

                                                                                                                                                                                                                                              (default: "/")

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              minExpandLevel?: number

                                                                                                                                                                                                                                              2: top-level nodes are not collapsible (default: 1)

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              quicksearch?: boolean

                                                                                                                                                                                                                                              navigate to next node by typing the first letters (default: false)

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              rtl?: boolean

                                                                                                                                                                                                                                              Right to left mode (default: false)

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              scrollOfs?: { bottom: number; top: number }

                                                                                                                                                                                                                                              optional margins for node.scrollIntoView() (default: {top: 0, bottom: 0})

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              scrollParent?: null | JQuery<HTMLElement>

                                                                                                                                                                                                                                              scrollable container for node.scrollIntoView() (default: $container)

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              selectMode?: FancytreeSelectMode

                                                                                                                                                                                                                                              default: multi_hier

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              source?: any

                                                                                                                                                                                                                                              Used to Initialize the tree.

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              strings?: TranslationTable

                                                                                                                                                                                                                                              Translation table

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              tabbable?: boolean

                                                                                                                                                                                                                                              Add tabindex='0' to container, so tree can be reached using TAB

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              table?: Table
                                                                                                                                                                                                                                              titlesTabbable?: boolean

                                                                                                                                                                                                                                              Add tabindex='0' to node title span, so it can receive keyboard focus

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              toggleEffect?: any

                                                                                                                                                                                                                                              Animation options, false:off (default: { effect: "blind", options: {direction: "vertical", scale: "box"}, duration: 200 })

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              tooltip?: boolean

                                                                                                                                                                                                                                              Tooltips

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              unselectable?:
                                                                                                                                                                                                                                                  | boolean
                                                                                                                                                                                                                                                  | ((event: JQueryEventObject, data: EventData) => undefined | boolean)

                                                                                                                                                                                                                                              (dynamic Option)Prevent (de-)selection using mouse or keyboard.

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              unselectableIgnore?:
                                                                                                                                                                                                                                                  | boolean
                                                                                                                                                                                                                                                  | ((event: JQueryEventObject, data: EventData) => undefined | boolean)

                                                                                                                                                                                                                                              (dynamic Option)Ignore this node when calculating the partsel status of parent nodes in selectMode 3 propagation.

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              unselectableStatus?:
                                                                                                                                                                                                                                                  | boolean
                                                                                                                                                                                                                                                  | ((event: JQueryEventObject, data: EventData) => undefined | boolean)

                                                                                                                                                                                                                                              (dynamic Option)Use this as constant selected value (overriding selectMode 3 propagation).

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Filter.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Filter.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.Filter.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.Filter.html index 116746306..494c129f9 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Filter.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.Filter.html @@ -1,6 +1,6 @@ Filter | trilium
                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Interface Filter

                                                                                                                                                                                                                                                Define filter-extension options

                                                                                                                                                                                                                                                interface Filter {
                                                                                                                                                                                                                                                    autoApply?: boolean;
                                                                                                                                                                                                                                                    autoExpand?: boolean;
                                                                                                                                                                                                                                                    counter?: boolean;
                                                                                                                                                                                                                                                    fuzzy?: boolean;
                                                                                                                                                                                                                                                    hideExpandedCounter?: boolean;
                                                                                                                                                                                                                                                    hideExpanders?: boolean;
                                                                                                                                                                                                                                                    highlight?: boolean;
                                                                                                                                                                                                                                                    leavesOnly?: boolean;
                                                                                                                                                                                                                                                    mode?: "hide" | "dimm";
                                                                                                                                                                                                                                                    nodata?: boolean;
                                                                                                                                                                                                                                                    [key: string]: any;
                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                • [key: string]: any

                                                                                                                                                                                                                                                  Support misc options

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                autoApply? +
                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                autoApply? autoExpand? counter? fuzzy? @@ -11,13 +11,13 @@ mode? nodata?

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                autoApply?: boolean

                                                                                                                                                                                                                                                Re-apply last filter if lazy data is loaded

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                autoExpand?: boolean

                                                                                                                                                                                                                                                Expand all branches that contain matches while filtered

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                counter?: boolean

                                                                                                                                                                                                                                                Show a badge with number of matching child nodes near parent icons

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                fuzzy?: boolean

                                                                                                                                                                                                                                                Match single characters in order, e.g. 'fb' will match 'FooBar'

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                hideExpandedCounter?: boolean

                                                                                                                                                                                                                                                Hide counter badge if parent is expanded

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                hideExpanders?: boolean

                                                                                                                                                                                                                                                Hide expanders if all child nodes are hidden by filter

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                highlight?: boolean

                                                                                                                                                                                                                                                Highlight matches by wrapping inside tags

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                leavesOnly?: boolean

                                                                                                                                                                                                                                                Match end nodes only

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                mode?: "hide" | "dimm"

                                                                                                                                                                                                                                                Grayout unmatched nodes (pass "hide" to remove unmatched node instead); default 'dimm'

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                nodata?: boolean

                                                                                                                                                                                                                                                Display a 'no data' status node if result is empty

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                autoExpand?: boolean

                                                                                                                                                                                                                                                Expand all branches that contain matches while filtered

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                counter?: boolean

                                                                                                                                                                                                                                                Show a badge with number of matching child nodes near parent icons

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                fuzzy?: boolean

                                                                                                                                                                                                                                                Match single characters in order, e.g. 'fb' will match 'FooBar'

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                hideExpandedCounter?: boolean

                                                                                                                                                                                                                                                Hide counter badge if parent is expanded

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                hideExpanders?: boolean

                                                                                                                                                                                                                                                Hide expanders if all child nodes are hidden by filter

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                highlight?: boolean

                                                                                                                                                                                                                                                Highlight matches by wrapping inside tags

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                leavesOnly?: boolean

                                                                                                                                                                                                                                                Match end nodes only

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                mode?: "hide" | "dimm"

                                                                                                                                                                                                                                                Grayout unmatched nodes (pass "hide" to remove unmatched node instead); default 'dimm'

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                nodata?: boolean

                                                                                                                                                                                                                                                Display a 'no data' status node if result is empty

                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Froca.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Froca.html similarity index 97% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.Froca.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.Froca.html index 50192daea..b9580d985 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Froca.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.Froca.html @@ -1,4 +1,4 @@ -Froca | trilium
                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                  Interface Froca

                                                                                                                                                                                                                                                  interface Froca {
                                                                                                                                                                                                                                                      attachments: Record<string, FAttachment>;
                                                                                                                                                                                                                                                      attributes: Record<string, FAttribute>;
                                                                                                                                                                                                                                                      blobPromises: Record<string, null | Promise<void | default>>;
                                                                                                                                                                                                                                                      branches: Record<string, FBranch>;
                                                                                                                                                                                                                                                      notes: Record<string, FNote>;
                                                                                                                                                                                                                                                      getAttachmentsForNote(noteId: string): Promise<FAttachment[]>;
                                                                                                                                                                                                                                                      getBlob(
                                                                                                                                                                                                                                                          entityType: string,
                                                                                                                                                                                                                                                          entityId: string,
                                                                                                                                                                                                                                                      ): Promise<null | void | default>;
                                                                                                                                                                                                                                                      getBranch(
                                                                                                                                                                                                                                                          branchId: string,
                                                                                                                                                                                                                                                          silentNotFoundError?: boolean,
                                                                                                                                                                                                                                                      ): undefined | FBranch;
                                                                                                                                                                                                                                                      getBranches(branchIds: string[], silentNotFoundError?: boolean): FBranch[];
                                                                                                                                                                                                                                                      getNote(
                                                                                                                                                                                                                                                          noteId: string,
                                                                                                                                                                                                                                                          silentNotFoundError?: boolean,
                                                                                                                                                                                                                                                      ): Promise<null | FNote>;
                                                                                                                                                                                                                                                      getNoteFromCache(noteId: string): FNote;
                                                                                                                                                                                                                                                      getNotes(
                                                                                                                                                                                                                                                          noteIds: string[],
                                                                                                                                                                                                                                                          silentNotFoundError?: boolean,
                                                                                                                                                                                                                                                      ): Promise<FNote[]>;
                                                                                                                                                                                                                                                      getNotesFromCache(
                                                                                                                                                                                                                                                          noteIds: string[],
                                                                                                                                                                                                                                                          silentNotFoundError?: boolean,
                                                                                                                                                                                                                                                      ): FNote[];
                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                  attachments +Froca | trilium
                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Interface Froca

                                                                                                                                                                                                                                                    interface Froca {
                                                                                                                                                                                                                                                        attachments: Record<string, FAttachment>;
                                                                                                                                                                                                                                                        attributes: Record<string, FAttribute>;
                                                                                                                                                                                                                                                        blobPromises: Record<string, null | Promise<void | default>>;
                                                                                                                                                                                                                                                        branches: Record<string, FBranch>;
                                                                                                                                                                                                                                                        notes: Record<string, FNote>;
                                                                                                                                                                                                                                                        getAttachmentsForNote(noteId: string): Promise<FAttachment[]>;
                                                                                                                                                                                                                                                        getBlob(
                                                                                                                                                                                                                                                            entityType: string,
                                                                                                                                                                                                                                                            entityId: string,
                                                                                                                                                                                                                                                        ): Promise<null | void | default>;
                                                                                                                                                                                                                                                        getBranch(
                                                                                                                                                                                                                                                            branchId: string,
                                                                                                                                                                                                                                                            silentNotFoundError?: boolean,
                                                                                                                                                                                                                                                        ): undefined | FBranch;
                                                                                                                                                                                                                                                        getBranches(branchIds: string[], silentNotFoundError?: boolean): FBranch[];
                                                                                                                                                                                                                                                        getNote(
                                                                                                                                                                                                                                                            noteId: string,
                                                                                                                                                                                                                                                            silentNotFoundError?: boolean,
                                                                                                                                                                                                                                                        ): Promise<null | FNote>;
                                                                                                                                                                                                                                                        getNoteFromCache(noteId: string): FNote;
                                                                                                                                                                                                                                                        getNotes(
                                                                                                                                                                                                                                                            noteIds: string[],
                                                                                                                                                                                                                                                            silentNotFoundError?: boolean,
                                                                                                                                                                                                                                                        ): Promise<FNote[]>;
                                                                                                                                                                                                                                                        getNotesFromCache(
                                                                                                                                                                                                                                                            noteIds: string[],
                                                                                                                                                                                                                                                            silentNotFoundError?: boolean,
                                                                                                                                                                                                                                                        ): FNote[];
                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                    attachments attributes blobPromises branches @@ -11,4 +11,4 @@ getNoteFromCache getNotes getNotesFromCache -

                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                    attachments: Record<string, FAttachment>
                                                                                                                                                                                                                                                    attributes: Record<string, FAttribute>
                                                                                                                                                                                                                                                    blobPromises: Record<string, null | Promise<void | default>>
                                                                                                                                                                                                                                                    branches: Record<string, FBranch>
                                                                                                                                                                                                                                                    notes: Record<string, FNote>

                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                    attachments: Record<string, FAttachment>
                                                                                                                                                                                                                                                    attributes: Record<string, FAttribute>
                                                                                                                                                                                                                                                    blobPromises: Record<string, null | Promise<void | default>>
                                                                                                                                                                                                                                                    branches: Record<string, FBranch>
                                                                                                                                                                                                                                                    notes: Record<string, FNote>

                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryEventObject.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.JQueryEventObject.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryEventObject.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.JQueryEventObject.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryInputEventObject.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.JQueryInputEventObject.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryInputEventObject.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.JQueryInputEventObject.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryKeyEventObject.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.JQueryKeyEventObject.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryKeyEventObject.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.JQueryKeyEventObject.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryMouseEventObject.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.JQueryMouseEventObject.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryMouseEventObject.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.JQueryMouseEventObject.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryPromise.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.JQueryPromise.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryPromise.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.JQueryPromise.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.List.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.List.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.List.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.List.html index c7a38e70f..a7684f74a 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.List.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.List.html @@ -1,4 +1,4 @@ -List | trilium
                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                      Interface List

                                                                                                                                                                                                                                                      interface List {
                                                                                                                                                                                                                                                          dnd5?: DragAndDrop5;
                                                                                                                                                                                                                                                          filter?: Filter;
                                                                                                                                                                                                                                                          table?: Table;
                                                                                                                                                                                                                                                          [extension: string]: any;
                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                      • [extension: string]: any
                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                      dnd5? +List | trilium
                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Interface List

                                                                                                                                                                                                                                                        interface List {
                                                                                                                                                                                                                                                            dnd5?: DragAndDrop5;
                                                                                                                                                                                                                                                            filter?: Filter;
                                                                                                                                                                                                                                                            table?: Table;
                                                                                                                                                                                                                                                            [extension: string]: any;
                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                        • [extension: string]: any
                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        dnd5? filter? table? -

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        dnd5?: DragAndDrop5
                                                                                                                                                                                                                                                        filter?: Filter
                                                                                                                                                                                                                                                        table?: Table

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        dnd5?: DragAndDrop5
                                                                                                                                                                                                                                                        filter?: Filter
                                                                                                                                                                                                                                                        table?: Table

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Marker.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Marker.html similarity index 98% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.Marker.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.Marker.html index b274de34d..6265ad364 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Marker.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.Marker.html @@ -1,2 +1,2 @@ -Marker | trilium
                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                          Interface Marker

                                                                                                                                                                                                                                                          interface Marker {
                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          name -

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          name: string

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                          +Marker | trilium
                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Interface Marker

                                                                                                                                                                                                                                                            interface Marker {
                                                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                            name +

                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                            name: string

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.MentionConfig.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.MentionConfig.html similarity index 97% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.MentionConfig.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.MentionConfig.html index c92ba9d97..7dcb30866 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.MentionConfig.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.MentionConfig.html @@ -1,2 +1,2 @@ -MentionConfig | trilium
                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                              Interface MentionConfig

                                                                                                                                                                                                                                                              interface MentionConfig {
                                                                                                                                                                                                                                                                  feeds: {
                                                                                                                                                                                                                                                                      feed: (queryText: string) => MentionItem[] | Promise<MentionItem[]>;
                                                                                                                                                                                                                                                                      itemRenderer?: (item: { highlightedNotePathTitle: string }) => void;
                                                                                                                                                                                                                                                                      marker: string;
                                                                                                                                                                                                                                                                      minimumCharacters: number;
                                                                                                                                                                                                                                                                  }[];
                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              feeds -

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              feeds: {
                                                                                                                                                                                                                                                                  feed: (queryText: string) => MentionItem[] | Promise<MentionItem[]>;
                                                                                                                                                                                                                                                                  itemRenderer?: (item: { highlightedNotePathTitle: string }) => void;
                                                                                                                                                                                                                                                                  marker: string;
                                                                                                                                                                                                                                                                  minimumCharacters: number;
                                                                                                                                                                                                                                                              }[]

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                              +MentionConfig | trilium
                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                Interface MentionConfig

                                                                                                                                                                                                                                                                interface MentionConfig {
                                                                                                                                                                                                                                                                    feeds: {
                                                                                                                                                                                                                                                                        feed: (queryText: string) => MentionItem[] | Promise<MentionItem[]>;
                                                                                                                                                                                                                                                                        itemRenderer?: (item: { highlightedNotePathTitle: string }) => void;
                                                                                                                                                                                                                                                                        marker: string;
                                                                                                                                                                                                                                                                        minimumCharacters: number;
                                                                                                                                                                                                                                                                    }[];
                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                feeds +

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                feeds: {
                                                                                                                                                                                                                                                                    feed: (queryText: string) => MentionItem[] | Promise<MentionItem[]>;
                                                                                                                                                                                                                                                                    itemRenderer?: (item: { highlightedNotePathTitle: string }) => void;
                                                                                                                                                                                                                                                                    marker: string;
                                                                                                                                                                                                                                                                    minimumCharacters: number;
                                                                                                                                                                                                                                                                }[]

                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.MentionItem.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.MentionItem.html similarity index 94% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.MentionItem.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.MentionItem.html index 92ed4edea..871282b54 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.MentionItem.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.MentionItem.html @@ -1,8 +1,8 @@ -MentionItem | trilium
                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                  Interface MentionItem

                                                                                                                                                                                                                                                                  interface MentionItem {
                                                                                                                                                                                                                                                                      action?: string;
                                                                                                                                                                                                                                                                      highlightedNotePathTitle?: string;
                                                                                                                                                                                                                                                                      id: string;
                                                                                                                                                                                                                                                                      link?: string;
                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                      notePath?: string;
                                                                                                                                                                                                                                                                      noteTitle?: string;
                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  action? +MentionItem | trilium
                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                    Interface MentionItem

                                                                                                                                                                                                                                                                    interface MentionItem {
                                                                                                                                                                                                                                                                        action?: string;
                                                                                                                                                                                                                                                                        highlightedNotePathTitle?: string;
                                                                                                                                                                                                                                                                        id: string;
                                                                                                                                                                                                                                                                        link?: string;
                                                                                                                                                                                                                                                                        name: string;
                                                                                                                                                                                                                                                                        notePath?: string;
                                                                                                                                                                                                                                                                        noteTitle?: string;
                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    action? highlightedNotePathTitle? id link? name notePath? noteTitle? -

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    action?: string
                                                                                                                                                                                                                                                                    highlightedNotePathTitle?: string
                                                                                                                                                                                                                                                                    id: string
                                                                                                                                                                                                                                                                    link?: string
                                                                                                                                                                                                                                                                    name: string
                                                                                                                                                                                                                                                                    notePath?: string
                                                                                                                                                                                                                                                                    noteTitle?: string

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    action?: string
                                                                                                                                                                                                                                                                    highlightedNotePathTitle?: string
                                                                                                                                                                                                                                                                    id: string
                                                                                                                                                                                                                                                                    link?: string
                                                                                                                                                                                                                                                                    name: string
                                                                                                                                                                                                                                                                    notePath?: string
                                                                                                                                                                                                                                                                    noteTitle?: string

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.MouseDownEvent.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.MouseDownEvent.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.MouseDownEvent.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.MouseDownEvent.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.MouseEventBase.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.MouseEventBase.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.MouseEventBase.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.MouseEventBase.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NodeData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.NodeData.html similarity index 95% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.NodeData.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.NodeData.html index 029598387..63d4eaf00 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NodeData.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.NodeData.html @@ -1,5 +1,5 @@ NodeData | trilium
                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                      Interface NodeData

                                                                                                                                                                                                                                                                      Data object passed to FancytreeNode() constructor. Note: typically these attributes are accessed by meber methods, e.g. node.isExpanded() and node.setSelected(false).

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      interface NodeData {
                                                                                                                                                                                                                                                                          active?: boolean;
                                                                                                                                                                                                                                                                          children?: NodeData[];
                                                                                                                                                                                                                                                                          data?: Object;
                                                                                                                                                                                                                                                                          expanded?: boolean;
                                                                                                                                                                                                                                                                          extraClasses?: string;
                                                                                                                                                                                                                                                                          focus?: boolean;
                                                                                                                                                                                                                                                                          folder?: boolean;
                                                                                                                                                                                                                                                                          hideCheckbox?: boolean;
                                                                                                                                                                                                                                                                          icon?: string | boolean;
                                                                                                                                                                                                                                                                          iconTooltip?: string;
                                                                                                                                                                                                                                                                          key?: string;
                                                                                                                                                                                                                                                                          lazy?: boolean;
                                                                                                                                                                                                                                                                          refKey?: string;
                                                                                                                                                                                                                                                                          selected?: boolean;
                                                                                                                                                                                                                                                                          statusNodeType?: string;
                                                                                                                                                                                                                                                                          title: string;
                                                                                                                                                                                                                                                                          tooltip?: string;
                                                                                                                                                                                                                                                                          type?: string;
                                                                                                                                                                                                                                                                          unselectable?: boolean;
                                                                                                                                                                                                                                                                          unselectableIgnore?: boolean;
                                                                                                                                                                                                                                                                          unselectableStatus?: boolean;
                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                      active? +
                                                                                                                                                                                                                                                                      interface NodeData {
                                                                                                                                                                                                                                                                          active?: boolean;
                                                                                                                                                                                                                                                                          children?: NodeData[];
                                                                                                                                                                                                                                                                          data?: Object;
                                                                                                                                                                                                                                                                          expanded?: boolean;
                                                                                                                                                                                                                                                                          extraClasses?: string;
                                                                                                                                                                                                                                                                          focus?: boolean;
                                                                                                                                                                                                                                                                          folder?: boolean;
                                                                                                                                                                                                                                                                          hideCheckbox?: boolean;
                                                                                                                                                                                                                                                                          icon?: string | boolean;
                                                                                                                                                                                                                                                                          iconTooltip?: string;
                                                                                                                                                                                                                                                                          key?: string;
                                                                                                                                                                                                                                                                          lazy?: boolean;
                                                                                                                                                                                                                                                                          refKey?: string;
                                                                                                                                                                                                                                                                          selected?: boolean;
                                                                                                                                                                                                                                                                          statusNodeType?: string;
                                                                                                                                                                                                                                                                          title: string;
                                                                                                                                                                                                                                                                          tooltip?: string;
                                                                                                                                                                                                                                                                          type?: string;
                                                                                                                                                                                                                                                                          unselectable?: boolean;
                                                                                                                                                                                                                                                                          unselectableIgnore?: boolean;
                                                                                                                                                                                                                                                                          unselectableStatus?: boolean;
                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                      active? children? data? expanded? @@ -21,16 +21,16 @@ unselectableIgnore? unselectableStatus?

                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                      active?: boolean

                                                                                                                                                                                                                                                                      (initialization only, but will not be stored with the node).

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      children?: NodeData[]

                                                                                                                                                                                                                                                                      optional array of child nodes

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      data?: Object

                                                                                                                                                                                                                                                                      all properties from will be copied to node.data

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      expanded?: boolean
                                                                                                                                                                                                                                                                      extraClasses?: string

                                                                                                                                                                                                                                                                      class names added to the node markup (separate with space)

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      focus?: boolean

                                                                                                                                                                                                                                                                      (initialization only, but will not be stored with the node).

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      folder?: boolean
                                                                                                                                                                                                                                                                      hideCheckbox?: boolean
                                                                                                                                                                                                                                                                      icon?: string | boolean
                                                                                                                                                                                                                                                                      iconTooltip?: string

                                                                                                                                                                                                                                                                      Will be added as title attribute of the node's icon span,thus enabling a tooltip.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      key?: string

                                                                                                                                                                                                                                                                      unique key for this node (auto-generated if omitted)

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      lazy?: boolean
                                                                                                                                                                                                                                                                      refKey?: string

                                                                                                                                                                                                                                                                      (reserved)

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      selected?: boolean
                                                                                                                                                                                                                                                                      statusNodeType?: string

                                                                                                                                                                                                                                                                      If set, make this node a status node. Values: 'error', 'loading', 'nodata', 'paging'.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      title: string

                                                                                                                                                                                                                                                                      node text (may contain HTML tags)

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      tooltip?: string
                                                                                                                                                                                                                                                                      type?: string

                                                                                                                                                                                                                                                                      Made available as node.type.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      unselectable?: boolean
                                                                                                                                                                                                                                                                      unselectableIgnore?: boolean

                                                                                                                                                                                                                                                                      Ignore this node when calculating the partsel status of parent nodes in selectMode 3 propagation.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      unselectableStatus?: boolean

                                                                                                                                                                                                                                                                      Use this as constant selected value(overriding selectMode 3 propagation).

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      children?: NodeData[]

                                                                                                                                                                                                                                                                      optional array of child nodes

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      data?: Object

                                                                                                                                                                                                                                                                      all properties from will be copied to node.data

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      expanded?: boolean
                                                                                                                                                                                                                                                                      extraClasses?: string

                                                                                                                                                                                                                                                                      class names added to the node markup (separate with space)

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      focus?: boolean

                                                                                                                                                                                                                                                                      (initialization only, but will not be stored with the node).

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      folder?: boolean
                                                                                                                                                                                                                                                                      hideCheckbox?: boolean
                                                                                                                                                                                                                                                                      icon?: string | boolean
                                                                                                                                                                                                                                                                      iconTooltip?: string

                                                                                                                                                                                                                                                                      Will be added as title attribute of the node's icon span,thus enabling a tooltip.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      key?: string

                                                                                                                                                                                                                                                                      unique key for this node (auto-generated if omitted)

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      lazy?: boolean
                                                                                                                                                                                                                                                                      refKey?: string

                                                                                                                                                                                                                                                                      (reserved)

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      selected?: boolean
                                                                                                                                                                                                                                                                      statusNodeType?: string

                                                                                                                                                                                                                                                                      If set, make this node a status node. Values: 'error', 'loading', 'nodata', 'paging'.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      title: string

                                                                                                                                                                                                                                                                      node text (may contain HTML tags)

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      tooltip?: string
                                                                                                                                                                                                                                                                      type?: string

                                                                                                                                                                                                                                                                      Made available as node.type.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      unselectable?: boolean
                                                                                                                                                                                                                                                                      unselectableIgnore?: boolean

                                                                                                                                                                                                                                                                      Ignore this node when calculating the partsel status of parent nodes in selectMode 3 propagation.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      unselectableStatus?: boolean

                                                                                                                                                                                                                                                                      Use this as constant selected value(overriding selectMode 3 propagation).

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NodePatch.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.NodePatch.html similarity index 97% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.NodePatch.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.NodePatch.html index 2eea84cf5..7321c11c6 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NodePatch.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.NodePatch.html @@ -1,9 +1,9 @@ NodePatch | trilium
                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                        Interface NodePatch

                                                                                                                                                                                                                                                                        Data object similar to NodeData, but with additional options. May be passed to FancytreeNode#applyPatch (Every property that is omitted (or set to undefined) will be ignored)

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        interface NodePatch {
                                                                                                                                                                                                                                                                            appendChildren?: NodeData;
                                                                                                                                                                                                                                                                            insertChildren?: NodeData;
                                                                                                                                                                                                                                                                            replaceChildren?: NodeData;
                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        appendChildren? +
                                                                                                                                                                                                                                                                        interface NodePatch {
                                                                                                                                                                                                                                                                            appendChildren?: NodeData;
                                                                                                                                                                                                                                                                            insertChildren?: NodeData;
                                                                                                                                                                                                                                                                            replaceChildren?: NodeData;
                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        appendChildren? insertChildren? replaceChildren?

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        appendChildren?: NodeData

                                                                                                                                                                                                                                                                        (not yet implemented)

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        insertChildren?: NodeData

                                                                                                                                                                                                                                                                        (not yet implemented)

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        replaceChildren?: NodeData

                                                                                                                                                                                                                                                                        (not yet implemented)

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        insertChildren?: NodeData

                                                                                                                                                                                                                                                                        (not yet implemented)

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        replaceChildren?: NodeData

                                                                                                                                                                                                                                                                        (not yet implemented)

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteCommandData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.NoteCommandData.html similarity index 95% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteCommandData.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.NoteCommandData.html index a9a1ad823..d1ec34fac 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteCommandData.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.NoteCommandData.html @@ -1,6 +1,6 @@ NoteCommandData | trilium
                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                          Interface NoteCommandData

                                                                                                                                                                                                                                                                          Base interface for the data/arguments for a given command (see CommandMappings).

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          interface NoteCommandData {
                                                                                                                                                                                                                                                                              hoistedNoteId?: null | string;
                                                                                                                                                                                                                                                                              notePath?: null | string;
                                                                                                                                                                                                                                                                              ntxId?: null | string;
                                                                                                                                                                                                                                                                              viewScope?: ViewScope;
                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          hoistedNoteId? +
                                                                                                                                                                                                                                                                          interface NoteCommandData {
                                                                                                                                                                                                                                                                              hoistedNoteId?: null | string;
                                                                                                                                                                                                                                                                              notePath?: null | string;
                                                                                                                                                                                                                                                                              ntxId?: null | string;
                                                                                                                                                                                                                                                                              viewScope?: ViewScope;
                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          hoistedNoteId? notePath? ntxId? viewScope? -

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          hoistedNoteId?: null | string
                                                                                                                                                                                                                                                                          notePath?: null | string
                                                                                                                                                                                                                                                                          ntxId?: null | string
                                                                                                                                                                                                                                                                          viewScope?: ViewScope

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          hoistedNoteId?: null | string
                                                                                                                                                                                                                                                                          notePath?: null | string
                                                                                                                                                                                                                                                                          ntxId?: null | string
                                                                                                                                                                                                                                                                          viewScope?: ViewScope

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteMetaData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.NoteMetaData.html similarity index 95% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteMetaData.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.NoteMetaData.html index 24d179c38..b29c0039a 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteMetaData.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.NoteMetaData.html @@ -1,5 +1,5 @@ -NoteMetaData | trilium
                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                            Interface NoteMetaData

                                                                                                                                                                                                                                                                            interface NoteMetaData {
                                                                                                                                                                                                                                                                                dateCreated: string;
                                                                                                                                                                                                                                                                                dateModified: string;
                                                                                                                                                                                                                                                                                utcDateCreated: string;
                                                                                                                                                                                                                                                                                utcDateModified: string;
                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                            dateCreated +NoteMetaData | trilium
                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                              Interface NoteMetaData

                                                                                                                                                                                                                                                                              interface NoteMetaData {
                                                                                                                                                                                                                                                                                  dateCreated: string;
                                                                                                                                                                                                                                                                                  dateModified: string;
                                                                                                                                                                                                                                                                                  utcDateCreated: string;
                                                                                                                                                                                                                                                                                  utcDateModified: string;
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              dateCreated dateModified utcDateCreated utcDateModified -

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              dateCreated: string
                                                                                                                                                                                                                                                                              dateModified: string
                                                                                                                                                                                                                                                                              utcDateCreated: string
                                                                                                                                                                                                                                                                              utcDateModified: string

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              dateCreated: string
                                                                                                                                                                                                                                                                              dateModified: string
                                                                                                                                                                                                                                                                              utcDateCreated: string
                                                                                                                                                                                                                                                                              utcDateModified: string

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NotePathRecord.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.NotePathRecord.html similarity index 95% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.NotePathRecord.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.NotePathRecord.html index 204ae9de5..7fd1e42ad 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NotePathRecord.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.NotePathRecord.html @@ -1,6 +1,6 @@ -NotePathRecord | trilium
                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                Interface NotePathRecord

                                                                                                                                                                                                                                                                                interface NotePathRecord {
                                                                                                                                                                                                                                                                                    isArchived: boolean;
                                                                                                                                                                                                                                                                                    isHidden: boolean;
                                                                                                                                                                                                                                                                                    isInHoistedSubTree: boolean;
                                                                                                                                                                                                                                                                                    isSearch?: boolean;
                                                                                                                                                                                                                                                                                    notePath: string[];
                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                isArchived +NotePathRecord | trilium
                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                  Interface NotePathRecord

                                                                                                                                                                                                                                                                                  interface NotePathRecord {
                                                                                                                                                                                                                                                                                      isArchived: boolean;
                                                                                                                                                                                                                                                                                      isHidden: boolean;
                                                                                                                                                                                                                                                                                      isInHoistedSubTree: boolean;
                                                                                                                                                                                                                                                                                      isSearch?: boolean;
                                                                                                                                                                                                                                                                                      notePath: string[];
                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  isArchived isHidden isInHoistedSubTree isSearch? notePath -

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  isArchived: boolean
                                                                                                                                                                                                                                                                                  isHidden: boolean
                                                                                                                                                                                                                                                                                  isInHoistedSubTree: boolean
                                                                                                                                                                                                                                                                                  isSearch?: boolean
                                                                                                                                                                                                                                                                                  notePath: string[]

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  isArchived: boolean
                                                                                                                                                                                                                                                                                  isHidden: boolean
                                                                                                                                                                                                                                                                                  isInHoistedSubTree: boolean
                                                                                                                                                                                                                                                                                  isSearch?: boolean
                                                                                                                                                                                                                                                                                  notePath: string[]

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteSwitchedContext.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.NoteSwitchedContext.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteSwitchedContext.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.NoteSwitchedContext.html index 9f0cc8d14..e14eaea60 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteSwitchedContext.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.NoteSwitchedContext.html @@ -1,3 +1,3 @@ -NoteSwitchedContext | trilium
                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                    Interface NoteSwitchedContext

                                                                                                                                                                                                                                                                                    interface NoteSwitchedContext {
                                                                                                                                                                                                                                                                                        noteContext: NoteContext;
                                                                                                                                                                                                                                                                                        notePath: undefined | null | string;
                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    noteContext +NoteSwitchedContext | trilium
                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                      Interface NoteSwitchedContext

                                                                                                                                                                                                                                                                                      interface NoteSwitchedContext {
                                                                                                                                                                                                                                                                                          noteContext: NoteContext;
                                                                                                                                                                                                                                                                                          notePath: undefined | null | string;
                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      noteContext notePath -

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      noteContext: NoteContext
                                                                                                                                                                                                                                                                                      notePath: undefined | null | string

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      noteContext: NoteContext
                                                                                                                                                                                                                                                                                      notePath: undefined | null | string

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.PersistData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.PersistData.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.PersistData.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.PersistData.html index 91dbeea8f..1c2723522 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.PersistData.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.PersistData.html @@ -1,5 +1,5 @@ -PersistData | trilium
                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                        Interface PersistData

                                                                                                                                                                                                                                                                                        interface PersistData {
                                                                                                                                                                                                                                                                                            active: null | string;
                                                                                                                                                                                                                                                                                            expanded: string[];
                                                                                                                                                                                                                                                                                            focus: null | string;
                                                                                                                                                                                                                                                                                            selected: string[];
                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        active +PersistData | trilium
                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                          Interface PersistData

                                                                                                                                                                                                                                                                                          interface PersistData {
                                                                                                                                                                                                                                                                                              active: null | string;
                                                                                                                                                                                                                                                                                              expanded: string[];
                                                                                                                                                                                                                                                                                              focus: null | string;
                                                                                                                                                                                                                                                                                              selected: string[];
                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          active expanded focus selected -

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          active: null | string
                                                                                                                                                                                                                                                                                          expanded: string[]
                                                                                                                                                                                                                                                                                          focus: null | string
                                                                                                                                                                                                                                                                                          selected: string[]

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          active: null | string
                                                                                                                                                                                                                                                                                          expanded: string[]
                                                                                                                                                                                                                                                                                          focus: null | string
                                                                                                                                                                                                                                                                                          selected: string[]

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Promise.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Promise.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.Promise.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.Promise.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.PromiseBase.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.PromiseBase.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.PromiseBase.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.PromiseBase.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.PromiseLike.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.PromiseLike.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.PromiseLike.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.PromiseLike.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.PromptDialogOptions.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.PromptDialogOptions.html similarity index 95% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.PromptDialogOptions.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.PromptDialogOptions.html index dde8d30a0..e2118fedb 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.PromptDialogOptions.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.PromptDialogOptions.html @@ -1,6 +1,6 @@ -PromptDialogOptions | trilium
                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                            Interface PromptDialogOptions

                                                                                                                                                                                                                                                                                            interface PromptDialogOptions {
                                                                                                                                                                                                                                                                                                callback?: (value: null | string) => void;
                                                                                                                                                                                                                                                                                                defaultValue?: string;
                                                                                                                                                                                                                                                                                                message?: string;
                                                                                                                                                                                                                                                                                                shown?: PromptShownDialogCallback;
                                                                                                                                                                                                                                                                                                title?: string;
                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                            callback? +PromptDialogOptions | trilium
                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                              Interface PromptDialogOptions

                                                                                                                                                                                                                                                                                              interface PromptDialogOptions {
                                                                                                                                                                                                                                                                                                  callback?: (value: null | string) => void;
                                                                                                                                                                                                                                                                                                  defaultValue?: string;
                                                                                                                                                                                                                                                                                                  message?: string;
                                                                                                                                                                                                                                                                                                  shown?: PromptShownDialogCallback;
                                                                                                                                                                                                                                                                                                  title?: string;
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              callback? defaultValue? message? shown? title? -

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              callback?: (value: null | string) => void
                                                                                                                                                                                                                                                                                              defaultValue?: string
                                                                                                                                                                                                                                                                                              message?: string
                                                                                                                                                                                                                                                                                              shown?: PromptShownDialogCallback
                                                                                                                                                                                                                                                                                              title?: string

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              callback?: (value: null | string) => void
                                                                                                                                                                                                                                                                                              defaultValue?: string
                                                                                                                                                                                                                                                                                              message?: string
                                                                                                                                                                                                                                                                                              shown?: PromptShownDialogCallback
                                                                                                                                                                                                                                                                                              title?: string

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ResolveOptions.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ResolveOptions.html similarity index 95% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.ResolveOptions.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.ResolveOptions.html index 45c2ad504..927d78b05 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ResolveOptions.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.ResolveOptions.html @@ -1,4 +1,4 @@ -ResolveOptions | trilium
                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                Interface ResolveOptions

                                                                                                                                                                                                                                                                                                interface ResolveOptions {
                                                                                                                                                                                                                                                                                                    deleteAllClones?: boolean;
                                                                                                                                                                                                                                                                                                    eraseNotes?: boolean;
                                                                                                                                                                                                                                                                                                    proceed: boolean;
                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                deleteAllClones? +ResolveOptions | trilium
                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                  Interface ResolveOptions

                                                                                                                                                                                                                                                                                                  interface ResolveOptions {
                                                                                                                                                                                                                                                                                                      deleteAllClones?: boolean;
                                                                                                                                                                                                                                                                                                      eraseNotes?: boolean;
                                                                                                                                                                                                                                                                                                      proceed: boolean;
                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  deleteAllClones? eraseNotes? proceed -

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  deleteAllClones?: boolean
                                                                                                                                                                                                                                                                                                  eraseNotes?: boolean
                                                                                                                                                                                                                                                                                                  proceed: boolean

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  deleteAllClones?: boolean
                                                                                                                                                                                                                                                                                                  eraseNotes?: boolean
                                                                                                                                                                                                                                                                                                  proceed: boolean

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.SetNoteOpts.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.SetNoteOpts.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.SetNoteOpts.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.SetNoteOpts.html index a8e3b89d9..8fe8711e4 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.SetNoteOpts.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.SetNoteOpts.html @@ -1,3 +1,3 @@ -SetNoteOpts | trilium
                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                    Interface SetNoteOpts

                                                                                                                                                                                                                                                                                                    interface SetNoteOpts {
                                                                                                                                                                                                                                                                                                        triggerSwitchEvent?: unknown;
                                                                                                                                                                                                                                                                                                        viewScope?: ViewScope;
                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    triggerSwitchEvent? +SetNoteOpts | trilium
                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                      Interface SetNoteOpts

                                                                                                                                                                                                                                                                                                      interface SetNoteOpts {
                                                                                                                                                                                                                                                                                                          triggerSwitchEvent?: unknown;
                                                                                                                                                                                                                                                                                                          viewScope?: ViewScope;
                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      triggerSwitchEvent? viewScope? -

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      triggerSwitchEvent?: unknown
                                                                                                                                                                                                                                                                                                      viewScope?: ViewScope

                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      triggerSwitchEvent?: unknown
                                                                                                                                                                                                                                                                                                      viewScope?: ViewScope

                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ShownCallbackData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ShownCallbackData.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.ShownCallbackData.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.ShownCallbackData.html index 086a13be7..c22927e2e 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ShownCallbackData.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.ShownCallbackData.html @@ -1,5 +1,5 @@ -ShownCallbackData | trilium
                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                        Interface ShownCallbackData

                                                                                                                                                                                                                                                                                                        interface ShownCallbackData {
                                                                                                                                                                                                                                                                                                            $answer: null | JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                                                            $dialog: JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                                                            $form: JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                                                            $question: null | JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        $answer +ShownCallbackData | trilium
                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                          Interface ShownCallbackData

                                                                                                                                                                                                                                                                                                          interface ShownCallbackData {
                                                                                                                                                                                                                                                                                                              $answer: null | JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                                                              $dialog: JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                                                              $form: JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                                                              $question: null | JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          $answer $dialog $form $question -

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          $answer: null | JQuery<HTMLElement>
                                                                                                                                                                                                                                                                                                          $dialog: JQuery<HTMLElement>
                                                                                                                                                                                                                                                                                                          $form: JQuery<HTMLElement>
                                                                                                                                                                                                                                                                                                          $question: null | JQuery<HTMLElement>

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          $answer: null | JQuery<HTMLElement>
                                                                                                                                                                                                                                                                                                          $dialog: JQuery<HTMLElement>
                                                                                                                                                                                                                                                                                                          $form: JQuery<HTMLElement>
                                                                                                                                                                                                                                                                                                          $question: null | JQuery<HTMLElement>

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Table.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Table.html similarity index 97% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.Table.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.Table.html index 2247e56a1..8e9ee226d 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Table.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.Table.html @@ -1,9 +1,9 @@ Table | trilium
                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                            Interface Table

                                                                                                                                                                                                                                                                                                            Define table-extension options

                                                                                                                                                                                                                                                                                                            interface Table {
                                                                                                                                                                                                                                                                                                                checkboxColumnIdx: any;
                                                                                                                                                                                                                                                                                                                indentation: number;
                                                                                                                                                                                                                                                                                                                nodeColumnIdx: number;
                                                                                                                                                                                                                                                                                                                [key: string]: any;
                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                            • [key: string]: any

                                                                                                                                                                                                                                                                                                              Support misc options

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            checkboxColumnIdx +
                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            checkboxColumnIdx indentation nodeColumnIdx

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            checkboxColumnIdx: any

                                                                                                                                                                                                                                                                                                            Render the checkboxes into the this column index (default: nodeColumnIdx)

                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            indentation: number

                                                                                                                                                                                                                                                                                                            Indent every node level by 16px; default: 16

                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            nodeColumnIdx: number

                                                                                                                                                                                                                                                                                                            Render node expander, icon, and title to this column (default: 0)

                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            indentation: number

                                                                                                                                                                                                                                                                                                            Indent every node level by 16px; default: 16

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            nodeColumnIdx: number

                                                                                                                                                                                                                                                                                                            Render node expander, icon, and title to this column (default: 0)

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextEditor.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.TextEditor.html similarity index 97% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.TextEditor.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.TextEditor.html index 17de045ea..9db34905d 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextEditor.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.TextEditor.html @@ -1,4 +1,4 @@ -TextEditor | trilium
                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                              Interface TextEditor

                                                                                                                                                                                                                                                                                                              interface TextEditor {
                                                                                                                                                                                                                                                                                                                  conversion: {
                                                                                                                                                                                                                                                                                                                      for(
                                                                                                                                                                                                                                                                                                                          filter: string,
                                                                                                                                                                                                                                                                                                                      ): {
                                                                                                                                                                                                                                                                                                                          markerToHighlight(
                                                                                                                                                                                                                                                                                                                              data: { model: string; view: (data: { markerName: string }) => void },
                                                                                                                                                                                                                                                                                                                          ): any;
                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                  data: {
                                                                                                                                                                                                                                                                                                                      processor: { toView(html: string): any };
                                                                                                                                                                                                                                                                                                                      toModel(viewFeragment: any): any;
                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                  editing: {
                                                                                                                                                                                                                                                                                                                      view: {
                                                                                                                                                                                                                                                                                                                          document: {
                                                                                                                                                                                                                                                                                                                              getRoot(): CKNode;
                                                                                                                                                                                                                                                                                                                              on(
                                                                                                                                                                                                                                                                                                                                  event: string,
                                                                                                                                                                                                                                                                                                                                  cb: (event: CKEvent, data: { preventDefault(): any }) => void,
                                                                                                                                                                                                                                                                                                                                  opts?: { priority: "high" },
                                                                                                                                                                                                                                                                                                                              ): any;
                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                          domRoots: { values: () => { next: () => { value: string } } };
                                                                                                                                                                                                                                                                                                                          change(cb: (writer: Writer) => void): any;
                                                                                                                                                                                                                                                                                                                          focus(): void;
                                                                                                                                                                                                                                                                                                                          scrollToTheSelection(): void;
                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                  model: {
                                                                                                                                                                                                                                                                                                                      document: {
                                                                                                                                                                                                                                                                                                                          differ: {
                                                                                                                                                                                                                                                                                                                              getChanges(): {
                                                                                                                                                                                                                                                                                                                                  name: string;
                                                                                                                                                                                                                                                                                                                                  position?: { nodeAfter?: CKNode; parent: CKNode; toJSON(): Object };
                                                                                                                                                                                                                                                                                                                                  type: string;
                                                                                                                                                                                                                                                                                                                              }[];
                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                          selection: {
                                                                                                                                                                                                                                                                                                                              isCollapsed: boolean;
                                                                                                                                                                                                                                                                                                                              getAttribute(attribute: string): string;
                                                                                                                                                                                                                                                                                                                              getFirstPosition(): undefined | TextPosition;
                                                                                                                                                                                                                                                                                                                              getFirstRange(): Range;
                                                                                                                                                                                                                                                                                                                              getLastPosition(): undefined | TextPosition;
                                                                                                                                                                                                                                                                                                                              getSelectedElement(): CKNode;
                                                                                                                                                                                                                                                                                                                              hasAttribute(attribute: string): boolean;
                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                          getRoot(): CKNode;
                                                                                                                                                                                                                                                                                                                          on(event: string, cb: () => void): any;
                                                                                                                                                                                                                                                                                                                          registerPostFixer(callback: (writer: Writer) => boolean): any;
                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                      change(cb: (writer: Writer) => void): any;
                                                                                                                                                                                                                                                                                                                      insertContent(modelFragment: any, selection?: any): any;
                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                  plugins: { get(command: string): any };
                                                                                                                                                                                                                                                                                                                  sourceElement: HTMLElement;
                                                                                                                                                                                                                                                                                                                  create(
                                                                                                                                                                                                                                                                                                                      el: HTMLElement,
                                                                                                                                                                                                                                                                                                                      config: {
                                                                                                                                                                                                                                                                                                                          mention: MentionConfig;
                                                                                                                                                                                                                                                                                                                          placeholder: string;
                                                                                                                                                                                                                                                                                                                          removePlugins?: string[];
                                                                                                                                                                                                                                                                                                                          toolbar: { items: any[] };
                                                                                                                                                                                                                                                                                                                      },
                                                                                                                                                                                                                                                                                                                  ): any;
                                                                                                                                                                                                                                                                                                                  enableReadOnlyMode(reason: string): any;
                                                                                                                                                                                                                                                                                                                  execute<T>(action: string, ...args: unknown[]): T;
                                                                                                                                                                                                                                                                                                                  focus(): void;
                                                                                                                                                                                                                                                                                                                  getData(): string;
                                                                                                                                                                                                                                                                                                                  getSelectedHtml(): string;
                                                                                                                                                                                                                                                                                                                  removeSelection(): void;
                                                                                                                                                                                                                                                                                                                  setData(data: string): void;
                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              conversion +TextEditor | trilium
                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                Interface TextEditor

                                                                                                                                                                                                                                                                                                                interface TextEditor {
                                                                                                                                                                                                                                                                                                                    conversion: {
                                                                                                                                                                                                                                                                                                                        for(
                                                                                                                                                                                                                                                                                                                            filter: string,
                                                                                                                                                                                                                                                                                                                        ): {
                                                                                                                                                                                                                                                                                                                            markerToHighlight(
                                                                                                                                                                                                                                                                                                                                data: { model: string; view: (data: { markerName: string }) => void },
                                                                                                                                                                                                                                                                                                                            ): any;
                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                    data: {
                                                                                                                                                                                                                                                                                                                        processor: { toView(html: string): any };
                                                                                                                                                                                                                                                                                                                        toModel(viewFeragment: any): any;
                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                    editing: {
                                                                                                                                                                                                                                                                                                                        view: {
                                                                                                                                                                                                                                                                                                                            document: {
                                                                                                                                                                                                                                                                                                                                getRoot(): CKNode;
                                                                                                                                                                                                                                                                                                                                on(
                                                                                                                                                                                                                                                                                                                                    event: string,
                                                                                                                                                                                                                                                                                                                                    cb: (event: CKEvent, data: { preventDefault(): any }) => void,
                                                                                                                                                                                                                                                                                                                                    opts?: { priority: "high" },
                                                                                                                                                                                                                                                                                                                                ): any;
                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                            domRoots: { values: () => { next: () => { value: string } } };
                                                                                                                                                                                                                                                                                                                            change(cb: (writer: Writer) => void): any;
                                                                                                                                                                                                                                                                                                                            focus(): void;
                                                                                                                                                                                                                                                                                                                            scrollToTheSelection(): void;
                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                    model: {
                                                                                                                                                                                                                                                                                                                        document: {
                                                                                                                                                                                                                                                                                                                            differ: {
                                                                                                                                                                                                                                                                                                                                getChanges(): {
                                                                                                                                                                                                                                                                                                                                    name: string;
                                                                                                                                                                                                                                                                                                                                    position?: { nodeAfter?: CKNode; parent: CKNode; toJSON(): Object };
                                                                                                                                                                                                                                                                                                                                    type: string;
                                                                                                                                                                                                                                                                                                                                }[];
                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                            selection: {
                                                                                                                                                                                                                                                                                                                                isCollapsed: boolean;
                                                                                                                                                                                                                                                                                                                                getAttribute(attribute: string): string;
                                                                                                                                                                                                                                                                                                                                getFirstPosition(): undefined | TextPosition;
                                                                                                                                                                                                                                                                                                                                getFirstRange(): Range;
                                                                                                                                                                                                                                                                                                                                getLastPosition(): undefined | TextPosition;
                                                                                                                                                                                                                                                                                                                                getSelectedElement(): CKNode;
                                                                                                                                                                                                                                                                                                                                hasAttribute(attribute: string): boolean;
                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                            getRoot(): CKNode;
                                                                                                                                                                                                                                                                                                                            on(event: string, cb: () => void): any;
                                                                                                                                                                                                                                                                                                                            registerPostFixer(callback: (writer: Writer) => boolean): any;
                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                        change(cb: (writer: Writer) => void): any;
                                                                                                                                                                                                                                                                                                                        insertContent(modelFragment: any, selection?: any): any;
                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                    plugins: { get(command: string): any };
                                                                                                                                                                                                                                                                                                                    sourceElement: HTMLElement;
                                                                                                                                                                                                                                                                                                                    create(
                                                                                                                                                                                                                                                                                                                        el: HTMLElement,
                                                                                                                                                                                                                                                                                                                        config: {
                                                                                                                                                                                                                                                                                                                            mention: MentionConfig;
                                                                                                                                                                                                                                                                                                                            placeholder: string;
                                                                                                                                                                                                                                                                                                                            removePlugins?: string[];
                                                                                                                                                                                                                                                                                                                            toolbar: { items: any[] };
                                                                                                                                                                                                                                                                                                                        },
                                                                                                                                                                                                                                                                                                                    ): any;
                                                                                                                                                                                                                                                                                                                    enableReadOnlyMode(reason: string): any;
                                                                                                                                                                                                                                                                                                                    execute<T>(action: string, ...args: unknown[]): T;
                                                                                                                                                                                                                                                                                                                    focus(): void;
                                                                                                                                                                                                                                                                                                                    getData(): string;
                                                                                                                                                                                                                                                                                                                    getSelectedHtml(): string;
                                                                                                                                                                                                                                                                                                                    removeSelection(): void;
                                                                                                                                                                                                                                                                                                                    setData(data: string): void;
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                conversion data editing model @@ -12,4 +12,4 @@ getSelectedHtml removeSelection setData -

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                conversion: {
                                                                                                                                                                                                                                                                                                                    for(
                                                                                                                                                                                                                                                                                                                        filter: string,
                                                                                                                                                                                                                                                                                                                    ): {
                                                                                                                                                                                                                                                                                                                        markerToHighlight(
                                                                                                                                                                                                                                                                                                                            data: { model: string; view: (data: { markerName: string }) => void },
                                                                                                                                                                                                                                                                                                                        ): any;
                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                data: {
                                                                                                                                                                                                                                                                                                                    processor: { toView(html: string): any };
                                                                                                                                                                                                                                                                                                                    toModel(viewFeragment: any): any;
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                editing: {
                                                                                                                                                                                                                                                                                                                    view: {
                                                                                                                                                                                                                                                                                                                        document: {
                                                                                                                                                                                                                                                                                                                            getRoot(): CKNode;
                                                                                                                                                                                                                                                                                                                            on(
                                                                                                                                                                                                                                                                                                                                event: string,
                                                                                                                                                                                                                                                                                                                                cb: (event: CKEvent, data: { preventDefault(): any }) => void,
                                                                                                                                                                                                                                                                                                                                opts?: { priority: "high" },
                                                                                                                                                                                                                                                                                                                            ): any;
                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                        domRoots: { values: () => { next: () => { value: string } } };
                                                                                                                                                                                                                                                                                                                        change(cb: (writer: Writer) => void): any;
                                                                                                                                                                                                                                                                                                                        focus(): void;
                                                                                                                                                                                                                                                                                                                        scrollToTheSelection(): void;
                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                model: {
                                                                                                                                                                                                                                                                                                                    document: {
                                                                                                                                                                                                                                                                                                                        differ: {
                                                                                                                                                                                                                                                                                                                            getChanges(): {
                                                                                                                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                                                                                                                position?: { nodeAfter?: CKNode; parent: CKNode; toJSON(): Object };
                                                                                                                                                                                                                                                                                                                                type: string;
                                                                                                                                                                                                                                                                                                                            }[];
                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                        selection: {
                                                                                                                                                                                                                                                                                                                            isCollapsed: boolean;
                                                                                                                                                                                                                                                                                                                            getAttribute(attribute: string): string;
                                                                                                                                                                                                                                                                                                                            getFirstPosition(): undefined | TextPosition;
                                                                                                                                                                                                                                                                                                                            getFirstRange(): Range;
                                                                                                                                                                                                                                                                                                                            getLastPosition(): undefined | TextPosition;
                                                                                                                                                                                                                                                                                                                            getSelectedElement(): CKNode;
                                                                                                                                                                                                                                                                                                                            hasAttribute(attribute: string): boolean;
                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                        getRoot(): CKNode;
                                                                                                                                                                                                                                                                                                                        on(event: string, cb: () => void): any;
                                                                                                                                                                                                                                                                                                                        registerPostFixer(callback: (writer: Writer) => boolean): any;
                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                    change(cb: (writer: Writer) => void): any;
                                                                                                                                                                                                                                                                                                                    insertContent(modelFragment: any, selection?: any): any;
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                plugins: { get(command: string): any }
                                                                                                                                                                                                                                                                                                                sourceElement: HTMLElement

                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                  • el: HTMLElement
                                                                                                                                                                                                                                                                                                                  • config: {
                                                                                                                                                                                                                                                                                                                        mention: MentionConfig;
                                                                                                                                                                                                                                                                                                                        placeholder: string;
                                                                                                                                                                                                                                                                                                                        removePlugins?: string[];
                                                                                                                                                                                                                                                                                                                        toolbar: { items: any[] };
                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                  Returns any

                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                conversion: {
                                                                                                                                                                                                                                                                                                                    for(
                                                                                                                                                                                                                                                                                                                        filter: string,
                                                                                                                                                                                                                                                                                                                    ): {
                                                                                                                                                                                                                                                                                                                        markerToHighlight(
                                                                                                                                                                                                                                                                                                                            data: { model: string; view: (data: { markerName: string }) => void },
                                                                                                                                                                                                                                                                                                                        ): any;
                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                data: {
                                                                                                                                                                                                                                                                                                                    processor: { toView(html: string): any };
                                                                                                                                                                                                                                                                                                                    toModel(viewFeragment: any): any;
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                editing: {
                                                                                                                                                                                                                                                                                                                    view: {
                                                                                                                                                                                                                                                                                                                        document: {
                                                                                                                                                                                                                                                                                                                            getRoot(): CKNode;
                                                                                                                                                                                                                                                                                                                            on(
                                                                                                                                                                                                                                                                                                                                event: string,
                                                                                                                                                                                                                                                                                                                                cb: (event: CKEvent, data: { preventDefault(): any }) => void,
                                                                                                                                                                                                                                                                                                                                opts?: { priority: "high" },
                                                                                                                                                                                                                                                                                                                            ): any;
                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                        domRoots: { values: () => { next: () => { value: string } } };
                                                                                                                                                                                                                                                                                                                        change(cb: (writer: Writer) => void): any;
                                                                                                                                                                                                                                                                                                                        focus(): void;
                                                                                                                                                                                                                                                                                                                        scrollToTheSelection(): void;
                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                model: {
                                                                                                                                                                                                                                                                                                                    document: {
                                                                                                                                                                                                                                                                                                                        differ: {
                                                                                                                                                                                                                                                                                                                            getChanges(): {
                                                                                                                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                                                                                                                position?: { nodeAfter?: CKNode; parent: CKNode; toJSON(): Object };
                                                                                                                                                                                                                                                                                                                                type: string;
                                                                                                                                                                                                                                                                                                                            }[];
                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                        selection: {
                                                                                                                                                                                                                                                                                                                            isCollapsed: boolean;
                                                                                                                                                                                                                                                                                                                            getAttribute(attribute: string): string;
                                                                                                                                                                                                                                                                                                                            getFirstPosition(): undefined | TextPosition;
                                                                                                                                                                                                                                                                                                                            getFirstRange(): Range;
                                                                                                                                                                                                                                                                                                                            getLastPosition(): undefined | TextPosition;
                                                                                                                                                                                                                                                                                                                            getSelectedElement(): CKNode;
                                                                                                                                                                                                                                                                                                                            hasAttribute(attribute: string): boolean;
                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                        getRoot(): CKNode;
                                                                                                                                                                                                                                                                                                                        on(event: string, cb: () => void): any;
                                                                                                                                                                                                                                                                                                                        registerPostFixer(callback: (writer: Writer) => boolean): any;
                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                    change(cb: (writer: Writer) => void): any;
                                                                                                                                                                                                                                                                                                                    insertContent(modelFragment: any, selection?: any): any;
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                plugins: { get(command: string): any }
                                                                                                                                                                                                                                                                                                                sourceElement: HTMLElement

                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                  • el: HTMLElement
                                                                                                                                                                                                                                                                                                                  • config: {
                                                                                                                                                                                                                                                                                                                        mention: MentionConfig;
                                                                                                                                                                                                                                                                                                                        placeholder: string;
                                                                                                                                                                                                                                                                                                                        removePlugins?: string[];
                                                                                                                                                                                                                                                                                                                        toolbar: { items: any[] };
                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                  Returns any

                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextNode.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.TextNode.html similarity index 95% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.TextNode.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.TextNode.html index 15687de89..c36502bc6 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextNode.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.TextNode.html @@ -1,6 +1,6 @@ -TextNode | trilium
                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                  Interface TextNode

                                                                                                                                                                                                                                                                                                                  interface TextNode {
                                                                                                                                                                                                                                                                                                                      _attrs: { get(key: string): { length: number } };
                                                                                                                                                                                                                                                                                                                      data: string;
                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                      previousSibling?: TextNode;
                                                                                                                                                                                                                                                                                                                      startOffset: number;
                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  _attrs +TextNode | trilium
                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                    Interface TextNode

                                                                                                                                                                                                                                                                                                                    interface TextNode {
                                                                                                                                                                                                                                                                                                                        _attrs: { get(key: string): { length: number } };
                                                                                                                                                                                                                                                                                                                        data: string;
                                                                                                                                                                                                                                                                                                                        name: string;
                                                                                                                                                                                                                                                                                                                        previousSibling?: TextNode;
                                                                                                                                                                                                                                                                                                                        startOffset: number;
                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    _attrs data name previousSibling? startOffset -

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    _attrs

                                                                                                                                                                                                                                                                                                                    _attrs: { get(key: string): { length: number } }
                                                                                                                                                                                                                                                                                                                    data: string
                                                                                                                                                                                                                                                                                                                    name: string
                                                                                                                                                                                                                                                                                                                    previousSibling?: TextNode
                                                                                                                                                                                                                                                                                                                    startOffset: number

                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    _attrs

                                                                                                                                                                                                                                                                                                                    _attrs: { get(key: string): { length: number } }
                                                                                                                                                                                                                                                                                                                    data: string
                                                                                                                                                                                                                                                                                                                    name: string
                                                                                                                                                                                                                                                                                                                    previousSibling?: TextNode
                                                                                                                                                                                                                                                                                                                    startOffset: number

                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextPosition.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.TextPosition.html similarity index 97% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.TextPosition.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.TextPosition.html index fb3d86028..3a6b4b7d1 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextPosition.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.TextPosition.html @@ -1,4 +1,4 @@ -TextPosition | trilium
                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                      Interface TextPosition

                                                                                                                                                                                                                                                                                                                      interface TextPosition {
                                                                                                                                                                                                                                                                                                                          offset: number;
                                                                                                                                                                                                                                                                                                                          textNode: TextNode;
                                                                                                                                                                                                                                                                                                                          compareWith(pos: TextPosition): string;
                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      offset +TextPosition | trilium
                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                        Interface TextPosition

                                                                                                                                                                                                                                                                                                                        interface TextPosition {
                                                                                                                                                                                                                                                                                                                            offset: number;
                                                                                                                                                                                                                                                                                                                            textNode: TextNode;
                                                                                                                                                                                                                                                                                                                            compareWith(pos: TextPosition): string;
                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        offset textNode

                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                        compareWith -

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        offset: number
                                                                                                                                                                                                                                                                                                                        textNode: TextNode

                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        offset: number
                                                                                                                                                                                                                                                                                                                        textNode: TextNode

                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextRange.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.TextRange.html similarity index 97% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.TextRange.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.TextRange.html index e42ab04aa..953be12f2 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextRange.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.TextRange.html @@ -1 +1 @@ -TextRange | trilium
                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                          Interface TextRange

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                          +TextRange | trilium
                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                            Interface TextRange

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Thenable.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Thenable.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.Thenable.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.Thenable.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TranslationTable.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.TranslationTable.html similarity index 97% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.TranslationTable.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.TranslationTable.html index 227f61cd6..6053603de 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TranslationTable.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.TranslationTable.html @@ -1,9 +1,9 @@ -TranslationTable | trilium
                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                              Interface TranslationTable

                                                                                                                                                                                                                                                                                                                              interface TranslationTable {
                                                                                                                                                                                                                                                                                                                                  loadError?: string;
                                                                                                                                                                                                                                                                                                                                  loading?: string;
                                                                                                                                                                                                                                                                                                                                  moreData?: string;
                                                                                                                                                                                                                                                                                                                                  noData?: string;
                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              loadError? +TranslationTable | trilium
                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                Interface TranslationTable

                                                                                                                                                                                                                                                                                                                                interface TranslationTable {
                                                                                                                                                                                                                                                                                                                                    loadError?: string;
                                                                                                                                                                                                                                                                                                                                    loading?: string;
                                                                                                                                                                                                                                                                                                                                    moreData?: string;
                                                                                                                                                                                                                                                                                                                                    noData?: string;
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                loadError? loading? moreData? noData?

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                loadError?: string

                                                                                                                                                                                                                                                                                                                                "Load error!"

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                loading?: string

                                                                                                                                                                                                                                                                                                                                "Loading..." // … would be escaped when escapeTitles is true

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                moreData?: string

                                                                                                                                                                                                                                                                                                                                "More..."

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                noData?: string

                                                                                                                                                                                                                                                                                                                                "No data."

                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                loading?: string

                                                                                                                                                                                                                                                                                                                                "Loading..." // … would be escaped when escapeTitles is true

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                moreData?: string

                                                                                                                                                                                                                                                                                                                                "More..."

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                noData?: string

                                                                                                                                                                                                                                                                                                                                "No data."

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TriggeredEvent.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.TriggeredEvent.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.TriggeredEvent.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.TriggeredEvent.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.UIEventBase.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.UIEventBase.html similarity index 100% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.UIEventBase.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.UIEventBase.html diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ViewScope.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ViewScope.html similarity index 96% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.ViewScope.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.ViewScope.html index a38044d3b..4150cfec7 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ViewScope.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.ViewScope.html @@ -1,14 +1,14 @@ -ViewScope | trilium
                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                  Interface ViewScope

                                                                                                                                                                                                                                                                                                                                  interface ViewScope {
                                                                                                                                                                                                                                                                                                                                      attachmentId?: string;
                                                                                                                                                                                                                                                                                                                                      highlightsListPreviousVisible?: boolean;
                                                                                                                                                                                                                                                                                                                                      highlightsListTemporarilyHidden?: boolean;
                                                                                                                                                                                                                                                                                                                                      readOnlyTemporarilyDisabled?: boolean;
                                                                                                                                                                                                                                                                                                                                      tocPreviousVisible?: boolean;
                                                                                                                                                                                                                                                                                                                                      tocTemporarilyHidden?: boolean;
                                                                                                                                                                                                                                                                                                                                      viewMode?: string;
                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  attachmentId? +ViewScope | trilium
                                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                    Interface ViewScope

                                                                                                                                                                                                                                                                                                                                    interface ViewScope {
                                                                                                                                                                                                                                                                                                                                        attachmentId?: string;
                                                                                                                                                                                                                                                                                                                                        highlightsListPreviousVisible?: boolean;
                                                                                                                                                                                                                                                                                                                                        highlightsListTemporarilyHidden?: boolean;
                                                                                                                                                                                                                                                                                                                                        readOnlyTemporarilyDisabled?: boolean;
                                                                                                                                                                                                                                                                                                                                        tocPreviousVisible?: boolean;
                                                                                                                                                                                                                                                                                                                                        tocTemporarilyHidden?: boolean;
                                                                                                                                                                                                                                                                                                                                        viewMode?: string;
                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    attachmentId? highlightsListPreviousVisible? highlightsListTemporarilyHidden? readOnlyTemporarilyDisabled? tocPreviousVisible? tocTemporarilyHidden? viewMode? -

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    attachmentId?: string
                                                                                                                                                                                                                                                                                                                                    highlightsListPreviousVisible?: boolean
                                                                                                                                                                                                                                                                                                                                    highlightsListTemporarilyHidden?: boolean
                                                                                                                                                                                                                                                                                                                                    readOnlyTemporarilyDisabled?: boolean
                                                                                                                                                                                                                                                                                                                                    tocPreviousVisible?: boolean
                                                                                                                                                                                                                                                                                                                                    tocTemporarilyHidden?: boolean
                                                                                                                                                                                                                                                                                                                                    viewMode?: string
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    attachmentId?: string
                                                                                                                                                                                                                                                                                                                                    highlightsListPreviousVisible?: boolean
                                                                                                                                                                                                                                                                                                                                    highlightsListTemporarilyHidden?: boolean
                                                                                                                                                                                                                                                                                                                                    readOnlyTemporarilyDisabled?: boolean
                                                                                                                                                                                                                                                                                                                                    tocPreviousVisible?: boolean
                                                                                                                                                                                                                                                                                                                                    tocTemporarilyHidden?: boolean
                                                                                                                                                                                                                                                                                                                                    viewMode?: string
                                                                                                                                                                                                                                                                                                                                    • "source", when viewing the source code of a note.
                                                                                                                                                                                                                                                                                                                                    • "attachments", when viewing the attachments of a note.
                                                                                                                                                                                                                                                                                                                                    • "contextual-help", if the current view represents a help window that was opened to the side of the main content.
                                                                                                                                                                                                                                                                                                                                    • "default", otherwise.
                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Writer.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Writer.html similarity index 97% rename from docs/backend_api/interfaces/Frontend_Script_API._internal_.Writer.html rename to docs/Script API/interfaces/Frontend_Script_API._internal_.Writer.html index 5a24afd5a..ab0caa6d4 100644 --- a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Writer.html +++ b/docs/Script API/interfaces/Frontend_Script_API._internal_.Writer.html @@ -1,4 +1,4 @@ -Writer | trilium
                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                      Interface Writer

                                                                                                                                                                                                                                                                                                                                      interface Writer {
                                                                                                                                                                                                                                                                                                                                          addMarker(
                                                                                                                                                                                                                                                                                                                                              name: string,
                                                                                                                                                                                                                                                                                                                                              opts: { range: Range; usingOperation: boolean },
                                                                                                                                                                                                                                                                                                                                          ): any;
                                                                                                                                                                                                                                                                                                                                          createElement(
                                                                                                                                                                                                                                                                                                                                              type: string,
                                                                                                                                                                                                                                                                                                                                              opts: Record<string, undefined | null | string>,
                                                                                                                                                                                                                                                                                                                                          ): any;
                                                                                                                                                                                                                                                                                                                                          createPositionAt(el: CKNode, opt?: number | "end"): any;
                                                                                                                                                                                                                                                                                                                                          createRange(start: number, end: number): Range;
                                                                                                                                                                                                                                                                                                                                          insertText(
                                                                                                                                                                                                                                                                                                                                              text: string,
                                                                                                                                                                                                                                                                                                                                              opts: undefined | Record<string, unknown> | TextPosition,
                                                                                                                                                                                                                                                                                                                                              position?: TextPosition,
                                                                                                                                                                                                                                                                                                                                          ): any;
                                                                                                                                                                                                                                                                                                                                          removeMarker(name: string): any;
                                                                                                                                                                                                                                                                                                                                          setAttribute(name: string, value: string, el: CKNode): any;
                                                                                                                                                                                                                                                                                                                                          setSelection(pos: number, pos?: number): any;
                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                      addMarker +Writer | trilium
                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                        Interface Writer

                                                                                                                                                                                                                                                                                                                                        interface Writer {
                                                                                                                                                                                                                                                                                                                                            addMarker(
                                                                                                                                                                                                                                                                                                                                                name: string,
                                                                                                                                                                                                                                                                                                                                                opts: { range: Range; usingOperation: boolean },
                                                                                                                                                                                                                                                                                                                                            ): any;
                                                                                                                                                                                                                                                                                                                                            createElement(
                                                                                                                                                                                                                                                                                                                                                type: string,
                                                                                                                                                                                                                                                                                                                                                opts: Record<string, undefined | null | string>,
                                                                                                                                                                                                                                                                                                                                            ): any;
                                                                                                                                                                                                                                                                                                                                            createPositionAt(el: CKNode, opt?: number | "end"): any;
                                                                                                                                                                                                                                                                                                                                            createRange(start: number, end: number): Range;
                                                                                                                                                                                                                                                                                                                                            insertText(
                                                                                                                                                                                                                                                                                                                                                text: string,
                                                                                                                                                                                                                                                                                                                                                opts: undefined | Record<string, unknown> | TextPosition,
                                                                                                                                                                                                                                                                                                                                                position?: TextPosition,
                                                                                                                                                                                                                                                                                                                                            ): any;
                                                                                                                                                                                                                                                                                                                                            removeMarker(name: string): any;
                                                                                                                                                                                                                                                                                                                                            setAttribute(name: string, value: string, el: CKNode): any;
                                                                                                                                                                                                                                                                                                                                            setSelection(pos: number, pos?: number): any;
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                        addMarker createElement createPositionAt createRange @@ -6,4 +6,4 @@ removeMarker setAttribute setSelection -

                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                          • name: string
                                                                                                                                                                                                                                                                                                                                          • opts: { range: Range; usingOperation: boolean }

                                                                                                                                                                                                                                                                                                                                          Returns any

                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                          • type: string
                                                                                                                                                                                                                                                                                                                                          • opts: Record<string, undefined | null | string>

                                                                                                                                                                                                                                                                                                                                          Returns any

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                          • name: string
                                                                                                                                                                                                                                                                                                                                          • opts: { range: Range; usingOperation: boolean }

                                                                                                                                                                                                                                                                                                                                          Returns any

                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                          • type: string
                                                                                                                                                                                                                                                                                                                                          • opts: Record<string, undefined | null | string>

                                                                                                                                                                                                                                                                                                                                          Returns any

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/media/README-ZH_CN.md b/docs/Script API/media/README-ZH_CN.md similarity index 100% rename from docs/backend_api/media/README-ZH_CN.md rename to docs/Script API/media/README-ZH_CN.md diff --git a/docs/backend_api/media/README.es.md b/docs/Script API/media/README.es.md similarity index 100% rename from docs/backend_api/media/README.es.md rename to docs/Script API/media/README.es.md diff --git a/docs/backend_api/media/README.it.md b/docs/Script API/media/README.it.md similarity index 100% rename from docs/backend_api/media/README.it.md rename to docs/Script API/media/README.it.md diff --git a/docs/backend_api/media/README.ja.md b/docs/Script API/media/README.ja.md similarity index 100% rename from docs/backend_api/media/README.ja.md rename to docs/Script API/media/README.ja.md diff --git a/docs/backend_api/media/README.md b/docs/Script API/media/README.md similarity index 100% rename from docs/backend_api/media/README.md rename to docs/Script API/media/README.md diff --git a/docs/backend_api/media/README.ru.md b/docs/Script API/media/README.ru.md similarity index 100% rename from docs/backend_api/media/README.ru.md rename to docs/Script API/media/README.ru.md diff --git a/docs/backend_api/modules.html b/docs/Script API/modules.html similarity index 100% rename from docs/backend_api/modules.html rename to docs/Script API/modules.html diff --git a/docs/backend_api/modules/Backend_Script_API._internal_.EventEmitter.html b/docs/Script API/modules/Backend_Script_API._internal_.EventEmitter.html similarity index 100% rename from docs/backend_api/modules/Backend_Script_API._internal_.EventEmitter.html rename to docs/Script API/modules/Backend_Script_API._internal_.EventEmitter.html diff --git a/docs/backend_api/modules/Backend_Script_API._internal_.html b/docs/Script API/modules/Backend_Script_API._internal_.html similarity index 100% rename from docs/backend_api/modules/Backend_Script_API._internal_.html rename to docs/Script API/modules/Backend_Script_API._internal_.html diff --git a/docs/backend_api/modules/Backend_Script_API._internal_.node_modules__types_xml2js.html b/docs/Script API/modules/Backend_Script_API._internal_.node_modules__types_xml2js.html similarity index 100% rename from docs/backend_api/modules/Backend_Script_API._internal_.node_modules__types_xml2js.html rename to docs/Script API/modules/Backend_Script_API._internal_.node_modules__types_xml2js.html diff --git a/docs/backend_api/modules/Backend_Script_API._internal_.node_modules__types_xml2js.processors.html b/docs/Script API/modules/Backend_Script_API._internal_.node_modules__types_xml2js.processors.html similarity index 100% rename from docs/backend_api/modules/Backend_Script_API._internal_.node_modules__types_xml2js.processors.html rename to docs/Script API/modules/Backend_Script_API._internal_.node_modules__types_xml2js.processors.html diff --git a/docs/backend_api/modules/Backend_Script_API.html b/docs/Script API/modules/Backend_Script_API.html similarity index 100% rename from docs/backend_api/modules/Backend_Script_API.html rename to docs/Script API/modules/Backend_Script_API.html diff --git a/docs/backend_api/modules/Frontend_Script_API._internal_.html b/docs/Script API/modules/Frontend_Script_API._internal_.html similarity index 100% rename from docs/backend_api/modules/Frontend_Script_API._internal_.html rename to docs/Script API/modules/Frontend_Script_API._internal_.html diff --git a/docs/backend_api/modules/Frontend_Script_API.html b/docs/Script API/modules/Frontend_Script_API.html similarity index 100% rename from docs/backend_api/modules/Frontend_Script_API.html rename to docs/Script API/modules/Frontend_Script_API.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AddressFamily.html b/docs/Script API/types/Backend_Script_API._internal_.AddressFamily.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.AddressFamily.html rename to docs/Script API/types/Backend_Script_API._internal_.AddressFamily.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AnyRest.html b/docs/Script API/types/Backend_Script_API._internal_.AnyRest.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.AnyRest.html rename to docs/Script API/types/Backend_Script_API._internal_.AnyRest.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.Args.html b/docs/Script API/types/Backend_Script_API._internal_.Args.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.Args.html rename to docs/Script API/types/Backend_Script_API._internal_.Args.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.ArrayBufferLike.html b/docs/Script API/types/Backend_Script_API._internal_.ArrayBufferLike.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.ArrayBufferLike.html rename to docs/Script API/types/Backend_Script_API._internal_.ArrayBufferLike.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AttrFunction.html b/docs/Script API/types/Backend_Script_API._internal_.AttrFunction.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.AttrFunction.html rename to docs/Script API/types/Backend_Script_API._internal_.AttrFunction.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AttributeType.html b/docs/Script API/types/Backend_Script_API._internal_.AttributeType.html similarity index 98% rename from docs/backend_api/types/Backend_Script_API._internal_.AttributeType.html rename to docs/Script API/types/Backend_Script_API._internal_.AttributeType.html index 702124da6..264cf2554 100644 --- a/docs/backend_api/types/Backend_Script_API._internal_.AttributeType.html +++ b/docs/Script API/types/Backend_Script_API._internal_.AttributeType.html @@ -1 +1 @@ -AttributeType | trilium
                                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                          Type Alias AttributeType

                                                                                                                                                                                                                                                                                                                                          AttributeType: "label" | "relation" | "label-definition" | "relation-definition"

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                          +AttributeType | trilium
                                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                            Type Alias AttributeType

                                                                                                                                                                                                                                                                                                                                            AttributeType: "label" | "relation" | "label-definition" | "relation-definition"

                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AxiosAdapterConfig.html b/docs/Script API/types/Backend_Script_API._internal_.AxiosAdapterConfig.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.AxiosAdapterConfig.html rename to docs/Script API/types/Backend_Script_API._internal_.AxiosAdapterConfig.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AxiosAdapterName.html b/docs/Script API/types/Backend_Script_API._internal_.AxiosAdapterName.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.AxiosAdapterName.html rename to docs/Script API/types/Backend_Script_API._internal_.AxiosAdapterName.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AxiosHeaderMatcher.html b/docs/Script API/types/Backend_Script_API._internal_.AxiosHeaderMatcher.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.AxiosHeaderMatcher.html rename to docs/Script API/types/Backend_Script_API._internal_.AxiosHeaderMatcher.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AxiosHeaderParser.html b/docs/Script API/types/Backend_Script_API._internal_.AxiosHeaderParser.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.AxiosHeaderParser.html rename to docs/Script API/types/Backend_Script_API._internal_.AxiosHeaderParser.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AxiosHeaderValue.html b/docs/Script API/types/Backend_Script_API._internal_.AxiosHeaderValue.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.AxiosHeaderValue.html rename to docs/Script API/types/Backend_Script_API._internal_.AxiosHeaderValue.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AxiosPromise.html b/docs/Script API/types/Backend_Script_API._internal_.AxiosPromise.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.AxiosPromise.html rename to docs/Script API/types/Backend_Script_API._internal_.AxiosPromise.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AxiosRequestHeaders.html b/docs/Script API/types/Backend_Script_API._internal_.AxiosRequestHeaders.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.AxiosRequestHeaders.html rename to docs/Script API/types/Backend_Script_API._internal_.AxiosRequestHeaders.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AxiosRequestInterceptorUse.html b/docs/Script API/types/Backend_Script_API._internal_.AxiosRequestInterceptorUse.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.AxiosRequestInterceptorUse.html rename to docs/Script API/types/Backend_Script_API._internal_.AxiosRequestInterceptorUse.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AxiosResponseHeaders.html b/docs/Script API/types/Backend_Script_API._internal_.AxiosResponseHeaders.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.AxiosResponseHeaders.html rename to docs/Script API/types/Backend_Script_API._internal_.AxiosResponseHeaders.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AxiosResponseInterceptorUse.html b/docs/Script API/types/Backend_Script_API._internal_.AxiosResponseInterceptorUse.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.AxiosResponseInterceptorUse.html rename to docs/Script API/types/Backend_Script_API._internal_.AxiosResponseInterceptorUse.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.CommonRequestHeadersList.html b/docs/Script API/types/Backend_Script_API._internal_.CommonRequestHeadersList.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.CommonRequestHeadersList.html rename to docs/Script API/types/Backend_Script_API._internal_.CommonRequestHeadersList.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.CommonResponseHeadersList.html b/docs/Script API/types/Backend_Script_API._internal_.CommonResponseHeadersList.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.CommonResponseHeadersList.html rename to docs/Script API/types/Backend_Script_API._internal_.CommonResponseHeadersList.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.ContentType.html b/docs/Script API/types/Backend_Script_API._internal_.ContentType.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.ContentType.html rename to docs/Script API/types/Backend_Script_API._internal_.ContentType.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.DefaultEventMap.html b/docs/Script API/types/Backend_Script_API._internal_.DefaultEventMap.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.DefaultEventMap.html rename to docs/Script API/types/Backend_Script_API._internal_.DefaultEventMap.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.Element.html b/docs/Script API/types/Backend_Script_API._internal_.Element.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.Element.html rename to docs/Script API/types/Backend_Script_API._internal_.Element.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.EventMap.html b/docs/Script API/types/Backend_Script_API._internal_.EventMap.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.EventMap.html rename to docs/Script API/types/Backend_Script_API._internal_.EventMap.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.Exclude.html b/docs/Script API/types/Backend_Script_API._internal_.Exclude.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.Exclude.html rename to docs/Script API/types/Backend_Script_API._internal_.Exclude.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.IteratorResult.html b/docs/Script API/types/Backend_Script_API._internal_.IteratorResult.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.IteratorResult.html rename to docs/Script API/types/Backend_Script_API._internal_.IteratorResult.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.Key.html b/docs/Script API/types/Backend_Script_API._internal_.Key.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.Key.html rename to docs/Script API/types/Backend_Script_API._internal_.Key.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.Key2.html b/docs/Script API/types/Backend_Script_API._internal_.Key2.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.Key2.html rename to docs/Script API/types/Backend_Script_API._internal_.Key2.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.Listener.html b/docs/Script API/types/Backend_Script_API._internal_.Listener.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.Listener.html rename to docs/Script API/types/Backend_Script_API._internal_.Listener.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.LookupAddress.html b/docs/Script API/types/Backend_Script_API._internal_.LookupAddress.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.LookupAddress.html rename to docs/Script API/types/Backend_Script_API._internal_.LookupAddress.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.Omit.html b/docs/Script API/types/Backend_Script_API._internal_.Omit.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.Omit.html rename to docs/Script API/types/Backend_Script_API._internal_.Omit.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.Partial.html b/docs/Script API/types/Backend_Script_API._internal_.Partial.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.Partial.html rename to docs/Script API/types/Backend_Script_API._internal_.Partial.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.Pick.html b/docs/Script API/types/Backend_Script_API._internal_.Pick.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.Pick.html rename to docs/Script API/types/Backend_Script_API._internal_.Pick.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.PropertyKey.html b/docs/Script API/types/Backend_Script_API._internal_.PropertyKey.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.PropertyKey.html rename to docs/Script API/types/Backend_Script_API._internal_.PropertyKey.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.RawAxiosRequestHeaders.html b/docs/Script API/types/Backend_Script_API._internal_.RawAxiosRequestHeaders.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.RawAxiosRequestHeaders.html rename to docs/Script API/types/Backend_Script_API._internal_.RawAxiosRequestHeaders.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.RawAxiosResponseHeaders.html b/docs/Script API/types/Backend_Script_API._internal_.RawAxiosResponseHeaders.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.RawAxiosResponseHeaders.html rename to docs/Script API/types/Backend_Script_API._internal_.RawAxiosResponseHeaders.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.RawCommonResponseHeaders.html b/docs/Script API/types/Backend_Script_API._internal_.RawCommonResponseHeaders.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.RawCommonResponseHeaders.html rename to docs/Script API/types/Backend_Script_API._internal_.RawCommonResponseHeaders.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.Record.html b/docs/Script API/types/Backend_Script_API._internal_.Record.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.Record.html rename to docs/Script API/types/Backend_Script_API._internal_.Record.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.ResponseType.html b/docs/Script API/types/Backend_Script_API._internal_.ResponseType.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.ResponseType.html rename to docs/Script API/types/Backend_Script_API._internal_.ResponseType.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.Updater.html b/docs/Script API/types/Backend_Script_API._internal_.Updater.html similarity index 98% rename from docs/backend_api/types/Backend_Script_API._internal_.Updater.html rename to docs/Script API/types/Backend_Script_API._internal_.Updater.html index 423b42898..5fd4f1fa4 100644 --- a/docs/backend_api/types/Backend_Script_API._internal_.Updater.html +++ b/docs/Script API/types/Backend_Script_API._internal_.Updater.html @@ -1 +1 @@ -Updater | trilium
                                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                              Type Alias Updater

                                                                                                                                                                                                                                                                                                                                              Updater: () => void

                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                • (): void

                                                                                                                                                                                                                                                                                                                                                • Returns void

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                              +Updater | trilium
                                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                Type Alias Updater

                                                                                                                                                                                                                                                                                                                                                Updater: () => void

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                  • (): void

                                                                                                                                                                                                                                                                                                                                                  • Returns void

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/types/Backend_Script_API._internal_.node_modules__types_xml2js.Options.html b/docs/Script API/types/Backend_Script_API._internal_.node_modules__types_xml2js.Options.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.node_modules__types_xml2js.Options.html rename to docs/Script API/types/Backend_Script_API._internal_.node_modules__types_xml2js.Options.html diff --git a/docs/backend_api/types/Backend_Script_API._internal_.node_modules__types_xml2js.OptionsV2.html b/docs/Script API/types/Backend_Script_API._internal_.node_modules__types_xml2js.OptionsV2.html similarity index 100% rename from docs/backend_api/types/Backend_Script_API._internal_.node_modules__types_xml2js.OptionsV2.html rename to docs/Script API/types/Backend_Script_API._internal_.node_modules__types_xml2js.OptionsV2.html diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.AttributeType.html b/docs/Script API/types/Frontend_Script_API._internal_.AttributeType.html similarity index 98% rename from docs/backend_api/types/Frontend_Script_API._internal_.AttributeType.html rename to docs/Script API/types/Frontend_Script_API._internal_.AttributeType.html index f3184eea9..89d1dd789 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.AttributeType.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.AttributeType.html @@ -1,2 +1,2 @@ AttributeType | trilium
                                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                  Type Alias AttributeType

                                                                                                                                                                                                                                                                                                                                                  AttributeType: "label" | "relation"

                                                                                                                                                                                                                                                                                                                                                  There are currently only two types of attributes, labels or relations.

                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.CallbackBase.html b/docs/Script API/types/Frontend_Script_API._internal_.CallbackBase.html similarity index 100% rename from docs/backend_api/types/Frontend_Script_API._internal_.CallbackBase.html rename to docs/Script API/types/Frontend_Script_API._internal_.CallbackBase.html diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.CommandAndEventMappings.html b/docs/Script API/types/Frontend_Script_API._internal_.CommandAndEventMappings.html similarity index 98% rename from docs/backend_api/types/Frontend_Script_API._internal_.CommandAndEventMappings.html rename to docs/Script API/types/Frontend_Script_API._internal_.CommandAndEventMappings.html index 8e9863bb2..4f9720152 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.CommandAndEventMappings.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.CommandAndEventMappings.html @@ -1 +1 @@ -CommandAndEventMappings | trilium
                                                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                    Type Alias CommandAndEventMappings

                                                                                                                                                                                                                                                                                                                                                    CommandAndEventMappings: CommandMappings & EventMappings

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    +CommandAndEventMappings | trilium
                                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                      Type Alias CommandAndEventMappings

                                                                                                                                                                                                                                                                                                                                                      CommandAndEventMappings: CommandMappings & EventMappings

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.CommandMappings.html b/docs/Script API/types/Frontend_Script_API._internal_.CommandMappings.html similarity index 94% rename from docs/backend_api/types/Frontend_Script_API._internal_.CommandMappings.html rename to docs/Script API/types/Frontend_Script_API._internal_.CommandMappings.html index 17280d4ab..6a903f023 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.CommandMappings.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.CommandMappings.html @@ -1,5 +1,5 @@ CommandMappings | trilium
                                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                        Type Alias CommandMappings

                                                                                                                                                                                                                                                                                                                                                        The keys represent the different commands that can be triggered via AppContext#triggerCommand (first argument), and the values represent the data or arguments definition of the given command. All data for commands must extend CommandData.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        type CommandMappings = {
                                                                                                                                                                                                                                                                                                                                                            addNewLabel: CommandData;
                                                                                                                                                                                                                                                                                                                                                            addNewLabelDefinition: CommandData;
                                                                                                                                                                                                                                                                                                                                                            addNewRelation: CommandData;
                                                                                                                                                                                                                                                                                                                                                            addNewRelationDefinition: CommandData;
                                                                                                                                                                                                                                                                                                                                                            addNoteLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            addScriptLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            addSpacerLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            addTextToActiveEditor: CommandData & { text: string };
                                                                                                                                                                                                                                                                                                                                                            addWidgetLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            "api-log-messages": CommandData;
                                                                                                                                                                                                                                                                                                                                                            cloneNoteIdsTo: CommandData & { noteIds: string[] };
                                                                                                                                                                                                                                                                                                                                                            cloneNotesTo: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            closeActiveTab: CommandData & { $el: JQuery<HTMLElement> };
                                                                                                                                                                                                                                                                                                                                                            closeAllTabs: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeHlt: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeOtherTabs: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeProtectedSessionPasswordDialog: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeRightTabs: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeTab: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeThisNoteSplit: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeToc: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeTocCommand: CommandData;
                                                                                                                                                                                                                                                                                                                                                            collapseSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            convertNoteToAttachment: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            copyImageReferenceToClipboard: CommandData;
                                                                                                                                                                                                                                                                                                                                                            copyImageToClipboard: CommandData;
                                                                                                                                                                                                                                                                                                                                                            copyNotePathToClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            copyNotesToClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            copyTabToNewWindow: CommandData;
                                                                                                                                                                                                                                                                                                                                                            cutNotesToClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            delete: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            deleteFromMap: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                            deleteNotes: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            duplicateSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            editBranchPrefix: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            editNoteTitle: {};
                                                                                                                                                                                                                                                                                                                                                            enterProtectedSession: CommandData;
                                                                                                                                                                                                                                                                                                                                                            executeInActiveNoteDetailWidget: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                callback: (value: default | PromiseLike<default>) => void;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            executeWithCodeEditor: CommandData & ExecuteCommandData<CodeMirrorInstance>;
                                                                                                                                                                                                                                                                                                                                                            executeWithContentElement: CommandData & ExecuteCommandData<
                                                                                                                                                                                                                                                                                                                                                                JQuery<HTMLElement>,
                                                                                                                                                                                                                                                                                                                                                            >;
                                                                                                                                                                                                                                                                                                                                                            executeWithTextEditor: CommandData & ExecuteCommandData<TextEditor> & {
                                                                                                                                                                                                                                                                                                                                                                callback?: GetTextEditorCallback;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            executeWithTypeWidget: CommandData & ExecuteCommandData<default | null>;
                                                                                                                                                                                                                                                                                                                                                            expandSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            exportNote: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            focusAndSelectTitle: CommandData & { isNewNote?: boolean };
                                                                                                                                                                                                                                                                                                                                                            focusOnDetail: CommandData;
                                                                                                                                                                                                                                                                                                                                                            focusOnSearchDefinition: Required<CommandData>;
                                                                                                                                                                                                                                                                                                                                                            focusOnTitle: CommandData;
                                                                                                                                                                                                                                                                                                                                                            focusTree: CommandData;
                                                                                                                                                                                                                                                                                                                                                            hideFloatingButtons: {};
                                                                                                                                                                                                                                                                                                                                                            hideLeftPane: CommandData;
                                                                                                                                                                                                                                                                                                                                                            hoistNote: CommandData & { noteId: string };
                                                                                                                                                                                                                                                                                                                                                            importIntoNote: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            importMarkdownInline: CommandData;
                                                                                                                                                                                                                                                                                                                                                            insertChildNote: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            insertNoteAfter: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            leaveProtectedSession: CommandData;
                                                                                                                                                                                                                                                                                                                                                            moveBranchIdsTo: CommandData & { branchIds: string[] };
                                                                                                                                                                                                                                                                                                                                                            moveLauncherToAvailable: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            moveLauncherToVisible: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            moveNoteDown: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            moveNoteDownInHierarchy: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            moveNotesTo: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            moveNoteUp: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            moveNoteUpInHierarchy: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            moveTabToNewWindow: CommandData;
                                                                                                                                                                                                                                                                                                                                                            moveThisNoteSplit: CommandData & { isMovingLeft: boolean };
                                                                                                                                                                                                                                                                                                                                                            noteContextReorder: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                newMainNtxId?: string | null;
                                                                                                                                                                                                                                                                                                                                                                ntxIdsInOrder: string[];
                                                                                                                                                                                                                                                                                                                                                                oldMainNtxId?: string | null;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            openAboutDialog: CommandData;
                                                                                                                                                                                                                                                                                                                                                            openBulkActionsDialog: | ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                            | { selectedOrActiveNoteIds?: string[] };
                                                                                                                                                                                                                                                                                                                                                            openedFileUpdated: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                entityId: string;
                                                                                                                                                                                                                                                                                                                                                                entityType: string;
                                                                                                                                                                                                                                                                                                                                                                filePath: string;
                                                                                                                                                                                                                                                                                                                                                                lastModifiedMs: number;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            openGeoLocation: { event: MouseDownEvent; noteId: string };
                                                                                                                                                                                                                                                                                                                                                            openInTab: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            openInWindow: NoteCommandData;
                                                                                                                                                                                                                                                                                                                                                            openNewNoteSplit: NoteCommandData;
                                                                                                                                                                                                                                                                                                                                                            openNoteInNewSplit: CommandData;
                                                                                                                                                                                                                                                                                                                                                            openNoteInNewTab: CommandData;
                                                                                                                                                                                                                                                                                                                                                            openNoteInNewWindow: CommandData;
                                                                                                                                                                                                                                                                                                                                                            openNoteInSplit: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            pasteNotesAfterFromClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            pasteNotesFromClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            protectSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            recentChangesInSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            reEvaluateRightPaneVisibility: CommandData;
                                                                                                                                                                                                                                                                                                                                                            refreshNoteList: CommandData & { noteId: string };
                                                                                                                                                                                                                                                                                                                                                            refreshResults: {};
                                                                                                                                                                                                                                                                                                                                                            refreshSearchDefinition: {};
                                                                                                                                                                                                                                                                                                                                                            reloadAttributes: CommandData;
                                                                                                                                                                                                                                                                                                                                                            reopenLastTab: CommandData;
                                                                                                                                                                                                                                                                                                                                                            replaceMisspelling: CommandData;
                                                                                                                                                                                                                                                                                                                                                            resetLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            runActiveNote: CommandData;
                                                                                                                                                                                                                                                                                                                                                            saveAttributes: CommandData;
                                                                                                                                                                                                                                                                                                                                                            scrollContainerToCommand: CommandData & { position: number };
                                                                                                                                                                                                                                                                                                                                                            scrollToEnd: CommandData;
                                                                                                                                                                                                                                                                                                                                                            searchInSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            searchNotes: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                ancestorNoteId?: string | null;
                                                                                                                                                                                                                                                                                                                                                                searchString?: string;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            selectAllNotesInParent: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            setActiveScreen: CommandData & { screen: Screen };
                                                                                                                                                                                                                                                                                                                                                            setZoomFactorAndSave: { zoomFactor: string };
                                                                                                                                                                                                                                                                                                                                                            showAddLinkDialog: CommandData & { text: string; textTypeWidget: default };
                                                                                                                                                                                                                                                                                                                                                            showConfirmDeleteNoteBoxWithNoteDialog: ConfirmWithTitleOptions;
                                                                                                                                                                                                                                                                                                                                                            showConfirmDialog: ConfirmWithMessageOptions;
                                                                                                                                                                                                                                                                                                                                                            showDeleteNotesDialog: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                branchIdsToDelete: string[];
                                                                                                                                                                                                                                                                                                                                                                callback: (value: ResolveOptions) => void;
                                                                                                                                                                                                                                                                                                                                                                forceDeleteAllClones: boolean;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            showExportDialog: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                defaultType: "single"
                                                                                                                                                                                                                                                                                                                                                                | "subtree";
                                                                                                                                                                                                                                                                                                                                                                notePath: string;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            showImportDialog: CommandData & { noteId: string };
                                                                                                                                                                                                                                                                                                                                                            showIncludeNoteDialog: CommandData & { textTypeWidget: default };
                                                                                                                                                                                                                                                                                                                                                            showInfoDialog: ConfirmWithMessageOptions;
                                                                                                                                                                                                                                                                                                                                                            showLaunchBarSubtree: CommandData;
                                                                                                                                                                                                                                                                                                                                                            showLeftPane: CommandData;
                                                                                                                                                                                                                                                                                                                                                            showOptions: CommandData & { section: string };
                                                                                                                                                                                                                                                                                                                                                            showPasswordNotSet: CommandData;
                                                                                                                                                                                                                                                                                                                                                            showPromptDialog: PromptDialogOptions;
                                                                                                                                                                                                                                                                                                                                                            showProtectedSessionPasswordDialog: CommandData;
                                                                                                                                                                                                                                                                                                                                                            showRecentChanges: CommandData & { ancestorNoteId: string };
                                                                                                                                                                                                                                                                                                                                                            showRevisions: CommandData;
                                                                                                                                                                                                                                                                                                                                                            showUploadAttachmentsDialog: CommandData & { noteId: string };
                                                                                                                                                                                                                                                                                                                                                            sortChildNotes: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            toggleNoteHoisting: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            toggleZenMode: CommandData;
                                                                                                                                                                                                                                                                                                                                                            unprotectSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            updateAttributeList: CommandData & { attributes: Attribute[] };
                                                                                                                                                                                                                                                                                                                                                            updateAttributesList: { attributes: Attribute[] };
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        addNewLabel +
                                                                                                                                                                                                                                                                                                                                                        type CommandMappings = {
                                                                                                                                                                                                                                                                                                                                                            addNewLabel: CommandData;
                                                                                                                                                                                                                                                                                                                                                            addNewLabelDefinition: CommandData;
                                                                                                                                                                                                                                                                                                                                                            addNewRelation: CommandData;
                                                                                                                                                                                                                                                                                                                                                            addNewRelationDefinition: CommandData;
                                                                                                                                                                                                                                                                                                                                                            addNoteLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            addScriptLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            addSpacerLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            addTextToActiveEditor: CommandData & { text: string };
                                                                                                                                                                                                                                                                                                                                                            addWidgetLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            "api-log-messages": CommandData;
                                                                                                                                                                                                                                                                                                                                                            cloneNoteIdsTo: CommandData & { noteIds: string[] };
                                                                                                                                                                                                                                                                                                                                                            cloneNotesTo: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            closeActiveTab: CommandData & { $el: JQuery<HTMLElement> };
                                                                                                                                                                                                                                                                                                                                                            closeAllTabs: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeHlt: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeOtherTabs: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeProtectedSessionPasswordDialog: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeRightTabs: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeTab: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeThisNoteSplit: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeToc: CommandData;
                                                                                                                                                                                                                                                                                                                                                            closeTocCommand: CommandData;
                                                                                                                                                                                                                                                                                                                                                            collapseSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            convertNoteToAttachment: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            copyImageReferenceToClipboard: CommandData;
                                                                                                                                                                                                                                                                                                                                                            copyImageToClipboard: CommandData;
                                                                                                                                                                                                                                                                                                                                                            copyNotePathToClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            copyNotesToClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            copyTabToNewWindow: CommandData;
                                                                                                                                                                                                                                                                                                                                                            cutNotesToClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            delete: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            deleteFromMap: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                            deleteNotes: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            duplicateSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            editBranchPrefix: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            editNoteTitle: {};
                                                                                                                                                                                                                                                                                                                                                            enterProtectedSession: CommandData;
                                                                                                                                                                                                                                                                                                                                                            executeInActiveNoteDetailWidget: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                callback: (value: default | PromiseLike<default>) => void;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            executeWithCodeEditor: CommandData & ExecuteCommandData<CodeMirrorInstance>;
                                                                                                                                                                                                                                                                                                                                                            executeWithContentElement: CommandData & ExecuteCommandData<
                                                                                                                                                                                                                                                                                                                                                                JQuery<HTMLElement>,
                                                                                                                                                                                                                                                                                                                                                            >;
                                                                                                                                                                                                                                                                                                                                                            executeWithTextEditor: CommandData & ExecuteCommandData<TextEditor> & {
                                                                                                                                                                                                                                                                                                                                                                callback?: GetTextEditorCallback;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            executeWithTypeWidget: CommandData & ExecuteCommandData<default | null>;
                                                                                                                                                                                                                                                                                                                                                            expandSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            exportNote: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            focusAndSelectTitle: CommandData & { isNewNote?: boolean };
                                                                                                                                                                                                                                                                                                                                                            focusOnDetail: CommandData;
                                                                                                                                                                                                                                                                                                                                                            focusOnSearchDefinition: Required<CommandData>;
                                                                                                                                                                                                                                                                                                                                                            focusOnTitle: CommandData;
                                                                                                                                                                                                                                                                                                                                                            focusTree: CommandData;
                                                                                                                                                                                                                                                                                                                                                            hideFloatingButtons: {};
                                                                                                                                                                                                                                                                                                                                                            hideLeftPane: CommandData;
                                                                                                                                                                                                                                                                                                                                                            hoistNote: CommandData & { noteId: string };
                                                                                                                                                                                                                                                                                                                                                            importIntoNote: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            importMarkdownInline: CommandData;
                                                                                                                                                                                                                                                                                                                                                            insertChildNote: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            insertNoteAfter: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            leaveProtectedSession: CommandData;
                                                                                                                                                                                                                                                                                                                                                            moveBranchIdsTo: CommandData & { branchIds: string[] };
                                                                                                                                                                                                                                                                                                                                                            moveLauncherToAvailable: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            moveLauncherToVisible: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            moveNoteDown: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            moveNoteDownInHierarchy: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            moveNotesTo: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            moveNoteUp: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            moveNoteUpInHierarchy: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            moveTabToNewWindow: CommandData;
                                                                                                                                                                                                                                                                                                                                                            moveThisNoteSplit: CommandData & { isMovingLeft: boolean };
                                                                                                                                                                                                                                                                                                                                                            noteContextReorder: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                newMainNtxId?: string | null;
                                                                                                                                                                                                                                                                                                                                                                ntxIdsInOrder: string[];
                                                                                                                                                                                                                                                                                                                                                                oldMainNtxId?: string | null;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            openAboutDialog: CommandData;
                                                                                                                                                                                                                                                                                                                                                            openBulkActionsDialog: | ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                            | { selectedOrActiveNoteIds?: string[] };
                                                                                                                                                                                                                                                                                                                                                            openedFileUpdated: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                entityId: string;
                                                                                                                                                                                                                                                                                                                                                                entityType: string;
                                                                                                                                                                                                                                                                                                                                                                filePath: string;
                                                                                                                                                                                                                                                                                                                                                                lastModifiedMs: number;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            openGeoLocation: { event: MouseDownEvent; noteId: string };
                                                                                                                                                                                                                                                                                                                                                            openInTab: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            openInWindow: NoteCommandData;
                                                                                                                                                                                                                                                                                                                                                            openNewNoteSplit: NoteCommandData;
                                                                                                                                                                                                                                                                                                                                                            openNoteInNewSplit: CommandData;
                                                                                                                                                                                                                                                                                                                                                            openNoteInNewTab: CommandData;
                                                                                                                                                                                                                                                                                                                                                            openNoteInNewWindow: CommandData;
                                                                                                                                                                                                                                                                                                                                                            openNoteInSplit: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            pasteNotesAfterFromClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            pasteNotesFromClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            protectSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            recentChangesInSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            reEvaluateRightPaneVisibility: CommandData;
                                                                                                                                                                                                                                                                                                                                                            refreshNoteList: CommandData & { noteId: string };
                                                                                                                                                                                                                                                                                                                                                            refreshResults: {};
                                                                                                                                                                                                                                                                                                                                                            refreshSearchDefinition: {};
                                                                                                                                                                                                                                                                                                                                                            reloadAttributes: CommandData;
                                                                                                                                                                                                                                                                                                                                                            reopenLastTab: CommandData;
                                                                                                                                                                                                                                                                                                                                                            replaceMisspelling: CommandData;
                                                                                                                                                                                                                                                                                                                                                            resetLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            runActiveNote: CommandData;
                                                                                                                                                                                                                                                                                                                                                            saveAttributes: CommandData;
                                                                                                                                                                                                                                                                                                                                                            scrollContainerToCommand: CommandData & { position: number };
                                                                                                                                                                                                                                                                                                                                                            scrollToEnd: CommandData;
                                                                                                                                                                                                                                                                                                                                                            searchInSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            searchNotes: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                ancestorNoteId?: string | null;
                                                                                                                                                                                                                                                                                                                                                                searchString?: string;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            selectAllNotesInParent: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            setActiveScreen: CommandData & { screen: Screen };
                                                                                                                                                                                                                                                                                                                                                            setZoomFactorAndSave: { zoomFactor: string };
                                                                                                                                                                                                                                                                                                                                                            showAddLinkDialog: CommandData & { text: string; textTypeWidget: default };
                                                                                                                                                                                                                                                                                                                                                            showConfirmDeleteNoteBoxWithNoteDialog: ConfirmWithTitleOptions;
                                                                                                                                                                                                                                                                                                                                                            showConfirmDialog: ConfirmWithMessageOptions;
                                                                                                                                                                                                                                                                                                                                                            showDeleteNotesDialog: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                branchIdsToDelete: string[];
                                                                                                                                                                                                                                                                                                                                                                callback: (value: ResolveOptions) => void;
                                                                                                                                                                                                                                                                                                                                                                forceDeleteAllClones: boolean;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            showExportDialog: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                defaultType: "single"
                                                                                                                                                                                                                                                                                                                                                                | "subtree";
                                                                                                                                                                                                                                                                                                                                                                notePath: string;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            showImportDialog: CommandData & { noteId: string };
                                                                                                                                                                                                                                                                                                                                                            showIncludeNoteDialog: CommandData & { textTypeWidget: default };
                                                                                                                                                                                                                                                                                                                                                            showInfoDialog: ConfirmWithMessageOptions;
                                                                                                                                                                                                                                                                                                                                                            showLaunchBarSubtree: CommandData;
                                                                                                                                                                                                                                                                                                                                                            showLeftPane: CommandData;
                                                                                                                                                                                                                                                                                                                                                            showOptions: CommandData & { section: string };
                                                                                                                                                                                                                                                                                                                                                            showPasswordNotSet: CommandData;
                                                                                                                                                                                                                                                                                                                                                            showPromptDialog: PromptDialogOptions;
                                                                                                                                                                                                                                                                                                                                                            showProtectedSessionPasswordDialog: CommandData;
                                                                                                                                                                                                                                                                                                                                                            showRecentChanges: CommandData & { ancestorNoteId: string };
                                                                                                                                                                                                                                                                                                                                                            showRevisions: CommandData;
                                                                                                                                                                                                                                                                                                                                                            showUploadAttachmentsDialog: CommandData & { noteId: string };
                                                                                                                                                                                                                                                                                                                                                            sortChildNotes: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            toggleNoteHoisting: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            toggleZenMode: CommandData;
                                                                                                                                                                                                                                                                                                                                                            unprotectSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                            updateAttributeList: CommandData & { attributes: Attribute[] };
                                                                                                                                                                                                                                                                                                                                                            updateAttributesList: { attributes: Attribute[] };
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        addNewLabel addNewLabelDefinition addNewRelation addNewRelationDefinition @@ -122,8 +122,8 @@ unprotectSubtree updateAttributeList updateAttributesList -

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        addNewLabel: CommandData
                                                                                                                                                                                                                                                                                                                                                        addNewLabelDefinition: CommandData
                                                                                                                                                                                                                                                                                                                                                        addNewRelation: CommandData
                                                                                                                                                                                                                                                                                                                                                        addNewRelationDefinition: CommandData
                                                                                                                                                                                                                                                                                                                                                        addNoteLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        addScriptLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        addSpacerLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        addTextToActiveEditor: CommandData & { text: string }
                                                                                                                                                                                                                                                                                                                                                        addWidgetLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        "api-log-messages": CommandData
                                                                                                                                                                                                                                                                                                                                                        cloneNoteIdsTo: CommandData & { noteIds: string[] }
                                                                                                                                                                                                                                                                                                                                                        cloneNotesTo: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        closeActiveTab: CommandData & { $el: JQuery<HTMLElement> }
                                                                                                                                                                                                                                                                                                                                                        closeAllTabs: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeHlt: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeOtherTabs: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeProtectedSessionPasswordDialog: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeRightTabs: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeTab: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeThisNoteSplit: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeToc: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeTocCommand: CommandData
                                                                                                                                                                                                                                                                                                                                                        collapseSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        convertNoteToAttachment: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        copyImageReferenceToClipboard: CommandData
                                                                                                                                                                                                                                                                                                                                                        copyImageToClipboard: CommandData
                                                                                                                                                                                                                                                                                                                                                        copyNotePathToClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        copyNotesToClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        copyTabToNewWindow: CommandData
                                                                                                                                                                                                                                                                                                                                                        cutNotesToClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        delete: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        deleteFromMap: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                        deleteNotes: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        duplicateSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        editBranchPrefix: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        editNoteTitle: {}
                                                                                                                                                                                                                                                                                                                                                        enterProtectedSession: CommandData
                                                                                                                                                                                                                                                                                                                                                        executeInActiveNoteDetailWidget: CommandData & {
                                                                                                                                                                                                                                                                                                                                                            callback: (value: default | PromiseLike<default>) => void;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        executeWithCodeEditor: CommandData & ExecuteCommandData<CodeMirrorInstance>
                                                                                                                                                                                                                                                                                                                                                        executeWithContentElement: CommandData & ExecuteCommandData<JQuery<HTMLElement>>

                                                                                                                                                                                                                                                                                                                                                        Called upon when attempting to retrieve the content element of a NoteContext. +

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        addNewLabel: CommandData
                                                                                                                                                                                                                                                                                                                                                        addNewLabelDefinition: CommandData
                                                                                                                                                                                                                                                                                                                                                        addNewRelation: CommandData
                                                                                                                                                                                                                                                                                                                                                        addNewRelationDefinition: CommandData
                                                                                                                                                                                                                                                                                                                                                        addNoteLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        addScriptLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        addSpacerLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        addTextToActiveEditor: CommandData & { text: string }
                                                                                                                                                                                                                                                                                                                                                        addWidgetLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        "api-log-messages": CommandData
                                                                                                                                                                                                                                                                                                                                                        cloneNoteIdsTo: CommandData & { noteIds: string[] }
                                                                                                                                                                                                                                                                                                                                                        cloneNotesTo: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        closeActiveTab: CommandData & { $el: JQuery<HTMLElement> }
                                                                                                                                                                                                                                                                                                                                                        closeAllTabs: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeHlt: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeOtherTabs: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeProtectedSessionPasswordDialog: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeRightTabs: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeTab: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeThisNoteSplit: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeToc: CommandData
                                                                                                                                                                                                                                                                                                                                                        closeTocCommand: CommandData
                                                                                                                                                                                                                                                                                                                                                        collapseSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        convertNoteToAttachment: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        copyImageReferenceToClipboard: CommandData
                                                                                                                                                                                                                                                                                                                                                        copyImageToClipboard: CommandData
                                                                                                                                                                                                                                                                                                                                                        copyNotePathToClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        copyNotesToClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        copyTabToNewWindow: CommandData
                                                                                                                                                                                                                                                                                                                                                        cutNotesToClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        delete: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        deleteFromMap: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                        deleteNotes: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        duplicateSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        editBranchPrefix: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        editNoteTitle: {}
                                                                                                                                                                                                                                                                                                                                                        enterProtectedSession: CommandData
                                                                                                                                                                                                                                                                                                                                                        executeInActiveNoteDetailWidget: CommandData & {
                                                                                                                                                                                                                                                                                                                                                            callback: (value: default | PromiseLike<default>) => void;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        executeWithCodeEditor: CommandData & ExecuteCommandData<CodeMirrorInstance>
                                                                                                                                                                                                                                                                                                                                                        executeWithContentElement: CommandData & ExecuteCommandData<JQuery<HTMLElement>>

                                                                                                                                                                                                                                                                                                                                                        Called upon when attempting to retrieve the content element of a NoteContext. Generally should not be invoked manually, as it is used by NoteContext.getContentElement.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        executeWithTextEditor: CommandData & ExecuteCommandData<TextEditor> & {
                                                                                                                                                                                                                                                                                                                                                            callback?: GetTextEditorCallback;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        executeWithTypeWidget: CommandData & ExecuteCommandData<default | null>
                                                                                                                                                                                                                                                                                                                                                        expandSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        exportNote: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        focusAndSelectTitle: CommandData & { isNewNote?: boolean }
                                                                                                                                                                                                                                                                                                                                                        focusOnDetail: CommandData
                                                                                                                                                                                                                                                                                                                                                        focusOnSearchDefinition: Required<CommandData>
                                                                                                                                                                                                                                                                                                                                                        focusOnTitle: CommandData
                                                                                                                                                                                                                                                                                                                                                        focusTree: CommandData
                                                                                                                                                                                                                                                                                                                                                        hideFloatingButtons: {}
                                                                                                                                                                                                                                                                                                                                                        hideLeftPane: CommandData
                                                                                                                                                                                                                                                                                                                                                        hoistNote: CommandData & { noteId: string }
                                                                                                                                                                                                                                                                                                                                                        importIntoNote: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        importMarkdownInline: CommandData
                                                                                                                                                                                                                                                                                                                                                        insertChildNote: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        insertNoteAfter: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        leaveProtectedSession: CommandData
                                                                                                                                                                                                                                                                                                                                                        moveBranchIdsTo: CommandData & { branchIds: string[] }
                                                                                                                                                                                                                                                                                                                                                        moveLauncherToAvailable: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        moveLauncherToVisible: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        moveNoteDown: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        moveNoteDownInHierarchy: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        moveNotesTo: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        moveNoteUp: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        moveNoteUpInHierarchy: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        moveTabToNewWindow: CommandData
                                                                                                                                                                                                                                                                                                                                                        moveThisNoteSplit: CommandData & { isMovingLeft: boolean }
                                                                                                                                                                                                                                                                                                                                                        noteContextReorder: CommandData & {
                                                                                                                                                                                                                                                                                                                                                            newMainNtxId?: string | null;
                                                                                                                                                                                                                                                                                                                                                            ntxIdsInOrder: string[];
                                                                                                                                                                                                                                                                                                                                                            oldMainNtxId?: string | null;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        openAboutDialog: CommandData
                                                                                                                                                                                                                                                                                                                                                        openBulkActionsDialog:
                                                                                                                                                                                                                                                                                                                                                            | ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                            | { selectedOrActiveNoteIds?: string[] }
                                                                                                                                                                                                                                                                                                                                                        openedFileUpdated: CommandData & {
                                                                                                                                                                                                                                                                                                                                                            entityId: string;
                                                                                                                                                                                                                                                                                                                                                            entityType: string;
                                                                                                                                                                                                                                                                                                                                                            filePath: string;
                                                                                                                                                                                                                                                                                                                                                            lastModifiedMs: number;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        openGeoLocation: { event: MouseDownEvent; noteId: string }
                                                                                                                                                                                                                                                                                                                                                        openInTab: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        openInWindow: NoteCommandData
                                                                                                                                                                                                                                                                                                                                                        openNewNoteSplit: NoteCommandData
                                                                                                                                                                                                                                                                                                                                                        openNoteInNewSplit: CommandData
                                                                                                                                                                                                                                                                                                                                                        openNoteInNewTab: CommandData
                                                                                                                                                                                                                                                                                                                                                        openNoteInNewWindow: CommandData
                                                                                                                                                                                                                                                                                                                                                        openNoteInSplit: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        pasteNotesAfterFromClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        pasteNotesFromClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        protectSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        recentChangesInSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        reEvaluateRightPaneVisibility: CommandData
                                                                                                                                                                                                                                                                                                                                                        refreshNoteList: CommandData & { noteId: string }
                                                                                                                                                                                                                                                                                                                                                        refreshResults: {}
                                                                                                                                                                                                                                                                                                                                                        refreshSearchDefinition: {}
                                                                                                                                                                                                                                                                                                                                                        reloadAttributes: CommandData
                                                                                                                                                                                                                                                                                                                                                        reopenLastTab: CommandData
                                                                                                                                                                                                                                                                                                                                                        replaceMisspelling: CommandData

                                                                                                                                                                                                                                                                                                                                                        Works only in the electron context menu.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        resetLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        runActiveNote: CommandData
                                                                                                                                                                                                                                                                                                                                                        saveAttributes: CommandData
                                                                                                                                                                                                                                                                                                                                                        scrollContainerToCommand: CommandData & { position: number }
                                                                                                                                                                                                                                                                                                                                                        scrollToEnd: CommandData
                                                                                                                                                                                                                                                                                                                                                        searchInSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        searchNotes: CommandData & {
                                                                                                                                                                                                                                                                                                                                                            ancestorNoteId?: string | null;
                                                                                                                                                                                                                                                                                                                                                            searchString?: string;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        selectAllNotesInParent: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        setActiveScreen: CommandData & { screen: Screen }

                                                                                                                                                                                                                                                                                                                                                        Sets the active Screen (e.g. to toggle the tree sidebar). It triggers the EventMappings.activeScreenChanged event, but only if the provided screen is different than the current one.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        setZoomFactorAndSave: { zoomFactor: string }
                                                                                                                                                                                                                                                                                                                                                        showAddLinkDialog: CommandData & { text: string; textTypeWidget: default }
                                                                                                                                                                                                                                                                                                                                                        showConfirmDeleteNoteBoxWithNoteDialog: ConfirmWithTitleOptions
                                                                                                                                                                                                                                                                                                                                                        showConfirmDialog: ConfirmWithMessageOptions
                                                                                                                                                                                                                                                                                                                                                        showDeleteNotesDialog: CommandData & {
                                                                                                                                                                                                                                                                                                                                                            branchIdsToDelete: string[];
                                                                                                                                                                                                                                                                                                                                                            callback: (value: ResolveOptions) => void;
                                                                                                                                                                                                                                                                                                                                                            forceDeleteAllClones: boolean;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        showExportDialog: CommandData & {
                                                                                                                                                                                                                                                                                                                                                            defaultType: "single" | "subtree";
                                                                                                                                                                                                                                                                                                                                                            notePath: string;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        showImportDialog: CommandData & { noteId: string }
                                                                                                                                                                                                                                                                                                                                                        showIncludeNoteDialog: CommandData & { textTypeWidget: default }
                                                                                                                                                                                                                                                                                                                                                        showInfoDialog: ConfirmWithMessageOptions
                                                                                                                                                                                                                                                                                                                                                        showLaunchBarSubtree: CommandData
                                                                                                                                                                                                                                                                                                                                                        showLeftPane: CommandData
                                                                                                                                                                                                                                                                                                                                                        showOptions: CommandData & { section: string }
                                                                                                                                                                                                                                                                                                                                                        showPasswordNotSet: CommandData
                                                                                                                                                                                                                                                                                                                                                        showPromptDialog: PromptDialogOptions
                                                                                                                                                                                                                                                                                                                                                        showProtectedSessionPasswordDialog: CommandData
                                                                                                                                                                                                                                                                                                                                                        showRecentChanges: CommandData & { ancestorNoteId: string }
                                                                                                                                                                                                                                                                                                                                                        showRevisions: CommandData
                                                                                                                                                                                                                                                                                                                                                        showUploadAttachmentsDialog: CommandData & { noteId: string }
                                                                                                                                                                                                                                                                                                                                                        sortChildNotes: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        toggleNoteHoisting: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        toggleZenMode: CommandData
                                                                                                                                                                                                                                                                                                                                                        unprotectSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        updateAttributeList: CommandData & { attributes: Attribute[] }
                                                                                                                                                                                                                                                                                                                                                        updateAttributesList: { attributes: Attribute[] }

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                        addNewLabeladdNewLabelDefinitionaddNewRelationaddNewRelationDefinitionaddNoteLauncheraddScriptLauncheraddSpacerLauncheraddTextToActiveEditoraddWidgetLauncherapi-log-messagescloneNoteIdsTocloneNotesTocloseActiveTabcloseAllTabscloseHltcloseOtherTabscloseProtectedSessionPasswordDialogcloseRightTabscloseTabcloseThisNoteSplitcloseToccloseTocCommandcollapseSubtreeconvertNoteToAttachmentcopyImageReferenceToClipboardcopyImageToClipboardcopyNotePathToClipboardcopyNotesToClipboardcopyTabToNewWindowcutNotesToClipboarddeletedeleteFromMapdeleteNotesduplicateSubtreeeditBranchPrefixeditNoteTitleenterProtectedSessionexecuteInActiveNoteDetailWidgetexecuteWithCodeEditorexecuteWithContentElementexecuteWithTextEditorexecuteWithTypeWidgetexpandSubtreeexportNotefocusAndSelectTitlefocusOnDetailfocusOnSearchDefinitionfocusOnTitlefocusTreehideFloatingButtonshideLeftPanehoistNoteimportIntoNoteimportMarkdownInlineinsertChildNoteinsertNoteAfterleaveProtectedSessionmoveBranchIdsTomoveLauncherToAvailablemoveLauncherToVisiblemoveNoteDownmoveNoteDownInHierarchymoveNotesTomoveNoteUpmoveNoteUpInHierarchymoveTabToNewWindowmoveThisNoteSplitnoteContextReorderopenAboutDialogopenBulkActionsDialogopenedFileUpdatedopenGeoLocationopenInTabopenInWindowopenNewNoteSplitopenNoteInNewSplitopenNoteInNewTabopenNoteInNewWindowopenNoteInSplitpasteNotesAfterFromClipboardpasteNotesFromClipboardprotectSubtreerecentChangesInSubtreereEvaluateRightPaneVisibilityrefreshNoteListrefreshResultsrefreshSearchDefinitionreloadAttributesreopenLastTabreplaceMisspellingresetLauncherrunActiveNotesaveAttributesscrollContainerToCommandscrollToEndsearchInSubtreesearchNotesselectAllNotesInParentsetActiveScreensetZoomFactorAndSaveshowAddLinkDialogshowConfirmDeleteNoteBoxWithNoteDialogshowConfirmDialogshowDeleteNotesDialogshowExportDialogshowImportDialogshowIncludeNoteDialogshowInfoDialogshowLaunchBarSubtreeshowLeftPaneshowOptionsshowPasswordNotSetshowPromptDialogshowProtectedSessionPasswordDialogshowRecentChangesshowRevisionsshowUploadAttachmentsDialogsortChildNotestoggleNoteHoistingtoggleZenModeunprotectSubtreeupdateAttributeListupdateAttributesList
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        executeWithTextEditor: CommandData & ExecuteCommandData<TextEditor> & {
                                                                                                                                                                                                                                                                                                                                                            callback?: GetTextEditorCallback;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        executeWithTypeWidget: CommandData & ExecuteCommandData<default | null>
                                                                                                                                                                                                                                                                                                                                                        expandSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        exportNote: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        focusAndSelectTitle: CommandData & { isNewNote?: boolean }
                                                                                                                                                                                                                                                                                                                                                        focusOnDetail: CommandData
                                                                                                                                                                                                                                                                                                                                                        focusOnSearchDefinition: Required<CommandData>
                                                                                                                                                                                                                                                                                                                                                        focusOnTitle: CommandData
                                                                                                                                                                                                                                                                                                                                                        focusTree: CommandData
                                                                                                                                                                                                                                                                                                                                                        hideFloatingButtons: {}
                                                                                                                                                                                                                                                                                                                                                        hideLeftPane: CommandData
                                                                                                                                                                                                                                                                                                                                                        hoistNote: CommandData & { noteId: string }
                                                                                                                                                                                                                                                                                                                                                        importIntoNote: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        importMarkdownInline: CommandData
                                                                                                                                                                                                                                                                                                                                                        insertChildNote: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        insertNoteAfter: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        leaveProtectedSession: CommandData
                                                                                                                                                                                                                                                                                                                                                        moveBranchIdsTo: CommandData & { branchIds: string[] }
                                                                                                                                                                                                                                                                                                                                                        moveLauncherToAvailable: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        moveLauncherToVisible: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        moveNoteDown: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        moveNoteDownInHierarchy: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        moveNotesTo: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        moveNoteUp: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        moveNoteUpInHierarchy: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        moveTabToNewWindow: CommandData
                                                                                                                                                                                                                                                                                                                                                        moveThisNoteSplit: CommandData & { isMovingLeft: boolean }
                                                                                                                                                                                                                                                                                                                                                        noteContextReorder: CommandData & {
                                                                                                                                                                                                                                                                                                                                                            newMainNtxId?: string | null;
                                                                                                                                                                                                                                                                                                                                                            ntxIdsInOrder: string[];
                                                                                                                                                                                                                                                                                                                                                            oldMainNtxId?: string | null;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        openAboutDialog: CommandData
                                                                                                                                                                                                                                                                                                                                                        openBulkActionsDialog:
                                                                                                                                                                                                                                                                                                                                                            | ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                            | { selectedOrActiveNoteIds?: string[] }
                                                                                                                                                                                                                                                                                                                                                        openedFileUpdated: CommandData & {
                                                                                                                                                                                                                                                                                                                                                            entityId: string;
                                                                                                                                                                                                                                                                                                                                                            entityType: string;
                                                                                                                                                                                                                                                                                                                                                            filePath: string;
                                                                                                                                                                                                                                                                                                                                                            lastModifiedMs: number;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        openGeoLocation: { event: MouseDownEvent; noteId: string }
                                                                                                                                                                                                                                                                                                                                                        openInTab: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        openInWindow: NoteCommandData
                                                                                                                                                                                                                                                                                                                                                        openNewNoteSplit: NoteCommandData
                                                                                                                                                                                                                                                                                                                                                        openNoteInNewSplit: CommandData
                                                                                                                                                                                                                                                                                                                                                        openNoteInNewTab: CommandData
                                                                                                                                                                                                                                                                                                                                                        openNoteInNewWindow: CommandData
                                                                                                                                                                                                                                                                                                                                                        openNoteInSplit: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        pasteNotesAfterFromClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        pasteNotesFromClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        protectSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        recentChangesInSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        reEvaluateRightPaneVisibility: CommandData
                                                                                                                                                                                                                                                                                                                                                        refreshNoteList: CommandData & { noteId: string }
                                                                                                                                                                                                                                                                                                                                                        refreshResults: {}
                                                                                                                                                                                                                                                                                                                                                        refreshSearchDefinition: {}
                                                                                                                                                                                                                                                                                                                                                        reloadAttributes: CommandData
                                                                                                                                                                                                                                                                                                                                                        reopenLastTab: CommandData
                                                                                                                                                                                                                                                                                                                                                        replaceMisspelling: CommandData

                                                                                                                                                                                                                                                                                                                                                        Works only in the electron context menu.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        resetLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        runActiveNote: CommandData
                                                                                                                                                                                                                                                                                                                                                        saveAttributes: CommandData
                                                                                                                                                                                                                                                                                                                                                        scrollContainerToCommand: CommandData & { position: number }
                                                                                                                                                                                                                                                                                                                                                        scrollToEnd: CommandData
                                                                                                                                                                                                                                                                                                                                                        searchInSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        searchNotes: CommandData & {
                                                                                                                                                                                                                                                                                                                                                            ancestorNoteId?: string | null;
                                                                                                                                                                                                                                                                                                                                                            searchString?: string;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        selectAllNotesInParent: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        setActiveScreen: CommandData & { screen: Screen }

                                                                                                                                                                                                                                                                                                                                                        Sets the active Screen (e.g. to toggle the tree sidebar). It triggers the EventMappings.activeScreenChanged event, but only if the provided screen is different than the current one.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        setZoomFactorAndSave: { zoomFactor: string }
                                                                                                                                                                                                                                                                                                                                                        showAddLinkDialog: CommandData & { text: string; textTypeWidget: default }
                                                                                                                                                                                                                                                                                                                                                        showConfirmDeleteNoteBoxWithNoteDialog: ConfirmWithTitleOptions
                                                                                                                                                                                                                                                                                                                                                        showConfirmDialog: ConfirmWithMessageOptions
                                                                                                                                                                                                                                                                                                                                                        showDeleteNotesDialog: CommandData & {
                                                                                                                                                                                                                                                                                                                                                            branchIdsToDelete: string[];
                                                                                                                                                                                                                                                                                                                                                            callback: (value: ResolveOptions) => void;
                                                                                                                                                                                                                                                                                                                                                            forceDeleteAllClones: boolean;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        showExportDialog: CommandData & {
                                                                                                                                                                                                                                                                                                                                                            defaultType: "single" | "subtree";
                                                                                                                                                                                                                                                                                                                                                            notePath: string;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        showImportDialog: CommandData & { noteId: string }
                                                                                                                                                                                                                                                                                                                                                        showIncludeNoteDialog: CommandData & { textTypeWidget: default }
                                                                                                                                                                                                                                                                                                                                                        showInfoDialog: ConfirmWithMessageOptions
                                                                                                                                                                                                                                                                                                                                                        showLaunchBarSubtree: CommandData
                                                                                                                                                                                                                                                                                                                                                        showLeftPane: CommandData
                                                                                                                                                                                                                                                                                                                                                        showOptions: CommandData & { section: string }
                                                                                                                                                                                                                                                                                                                                                        showPasswordNotSet: CommandData
                                                                                                                                                                                                                                                                                                                                                        showPromptDialog: PromptDialogOptions
                                                                                                                                                                                                                                                                                                                                                        showProtectedSessionPasswordDialog: CommandData
                                                                                                                                                                                                                                                                                                                                                        showRecentChanges: CommandData & { ancestorNoteId: string }
                                                                                                                                                                                                                                                                                                                                                        showRevisions: CommandData
                                                                                                                                                                                                                                                                                                                                                        showUploadAttachmentsDialog: CommandData & { noteId: string }
                                                                                                                                                                                                                                                                                                                                                        sortChildNotes: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        toggleNoteHoisting: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        toggleZenMode: CommandData
                                                                                                                                                                                                                                                                                                                                                        unprotectSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                        updateAttributeList: CommandData & { attributes: Attribute[] }
                                                                                                                                                                                                                                                                                                                                                        updateAttributesList: { attributes: Attribute[] }

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                        addNewLabeladdNewLabelDefinitionaddNewRelationaddNewRelationDefinitionaddNoteLauncheraddScriptLauncheraddSpacerLauncheraddTextToActiveEditoraddWidgetLauncherapi-log-messagescloneNoteIdsTocloneNotesTocloseActiveTabcloseAllTabscloseHltcloseOtherTabscloseProtectedSessionPasswordDialogcloseRightTabscloseTabcloseThisNoteSplitcloseToccloseTocCommandcollapseSubtreeconvertNoteToAttachmentcopyImageReferenceToClipboardcopyImageToClipboardcopyNotePathToClipboardcopyNotesToClipboardcopyTabToNewWindowcutNotesToClipboarddeletedeleteFromMapdeleteNotesduplicateSubtreeeditBranchPrefixeditNoteTitleenterProtectedSessionexecuteInActiveNoteDetailWidgetexecuteWithCodeEditorexecuteWithContentElementexecuteWithTextEditorexecuteWithTypeWidgetexpandSubtreeexportNotefocusAndSelectTitlefocusOnDetailfocusOnSearchDefinitionfocusOnTitlefocusTreehideFloatingButtonshideLeftPanehoistNoteimportIntoNoteimportMarkdownInlineinsertChildNoteinsertNoteAfterleaveProtectedSessionmoveBranchIdsTomoveLauncherToAvailablemoveLauncherToVisiblemoveNoteDownmoveNoteDownInHierarchymoveNotesTomoveNoteUpmoveNoteUpInHierarchymoveTabToNewWindowmoveThisNoteSplitnoteContextReorderopenAboutDialogopenBulkActionsDialogopenedFileUpdatedopenGeoLocationopenInTabopenInWindowopenNewNoteSplitopenNoteInNewSplitopenNoteInNewTabopenNoteInNewWindowopenNoteInSplitpasteNotesAfterFromClipboardpasteNotesFromClipboardprotectSubtreerecentChangesInSubtreereEvaluateRightPaneVisibilityrefreshNoteListrefreshResultsrefreshSearchDefinitionreloadAttributesreopenLastTabreplaceMisspellingresetLauncherrunActiveNotesaveAttributesscrollContainerToCommandscrollToEndsearchInSubtreesearchNotesselectAllNotesInParentsetActiveScreensetZoomFactorAndSaveshowAddLinkDialogshowConfirmDeleteNoteBoxWithNoteDialogshowConfirmDialogshowDeleteNotesDialogshowExportDialogshowImportDialogshowIncludeNoteDialogshowInfoDialogshowLaunchBarSubtreeshowLeftPaneshowOptionsshowPasswordNotSetshowPromptDialogshowProtectedSessionPasswordDialogshowRecentChangesshowRevisionsshowUploadAttachmentsDialogsortChildNotestoggleNoteHoistingtoggleZenModeunprotectSubtreeupdateAttributeListupdateAttributesList
                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.CommandNames.html b/docs/Script API/types/Frontend_Script_API._internal_.CommandNames.html similarity index 98% rename from docs/backend_api/types/Frontend_Script_API._internal_.CommandNames.html rename to docs/Script API/types/Frontend_Script_API._internal_.CommandNames.html index c5da1ae0d..27a69e3d0 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.CommandNames.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.CommandNames.html @@ -1,2 +1,2 @@ CommandNames | trilium
                                                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                          Type Alias CommandNames

                                                                                                                                                                                                                                                                                                                                                          CommandNames: keyof CommandMappings

                                                                                                                                                                                                                                                                                                                                                          This type is a discriminated union which contains all the possible commands that can be triggered via AppContext.triggerCommand.

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.ConfirmDialogCallback.html b/docs/Script API/types/Frontend_Script_API._internal_.ConfirmDialogCallback.html similarity index 98% rename from docs/backend_api/types/Frontend_Script_API._internal_.ConfirmDialogCallback.html rename to docs/Script API/types/Frontend_Script_API._internal_.ConfirmDialogCallback.html index e365a9177..2ef3f5b7a 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.ConfirmDialogCallback.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.ConfirmDialogCallback.html @@ -1 +1 @@ -ConfirmDialogCallback | trilium
                                                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                            Type Alias ConfirmDialogCallback

                                                                                                                                                                                                                                                                                                                                                            ConfirmDialogCallback: (val?: ConfirmDialogResult) => void

                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                            +ConfirmDialogCallback | trilium
                                                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                              Type Alias ConfirmDialogCallback

                                                                                                                                                                                                                                                                                                                                                              ConfirmDialogCallback: (val?: ConfirmDialogResult) => void

                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.ConfirmDialogResult.html b/docs/Script API/types/Frontend_Script_API._internal_.ConfirmDialogResult.html similarity index 98% rename from docs/backend_api/types/Frontend_Script_API._internal_.ConfirmDialogResult.html rename to docs/Script API/types/Frontend_Script_API._internal_.ConfirmDialogResult.html index 88fc642d5..808ac119a 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.ConfirmDialogResult.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.ConfirmDialogResult.html @@ -1 +1 @@ -ConfirmDialogResult | trilium
                                                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                Type Alias ConfirmDialogResult

                                                                                                                                                                                                                                                                                                                                                                ConfirmDialogResult: false | ConfirmDialogOptions

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                +ConfirmDialogResult | trilium
                                                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                  Type Alias ConfirmDialogResult

                                                                                                                                                                                                                                                                                                                                                                  ConfirmDialogResult: false | ConfirmDialogOptions

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.ElementType.html b/docs/Script API/types/Frontend_Script_API._internal_.ElementType.html similarity index 98% rename from docs/backend_api/types/Frontend_Script_API._internal_.ElementType.html rename to docs/Script API/types/Frontend_Script_API._internal_.ElementType.html index d1890ab14..a535b42ce 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.ElementType.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.ElementType.html @@ -1 +1 @@ -ElementType | trilium
                                                                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                    Type Alias ElementType

                                                                                                                                                                                                                                                                                                                                                                    ElementType: HTMLElement | Document

                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                    +ElementType | trilium
                                                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                      Type Alias ElementType

                                                                                                                                                                                                                                                                                                                                                                      ElementType: HTMLElement | Document

                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.EventData.html b/docs/Script API/types/Frontend_Script_API._internal_.EventData.html similarity index 98% rename from docs/backend_api/types/Frontend_Script_API._internal_.EventData.html rename to docs/Script API/types/Frontend_Script_API._internal_.EventData.html index 8845a6196..20dea9b7e 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.EventData.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.EventData.html @@ -1 +1 @@ -EventData | trilium
                                                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                        Type Alias EventData<T>

                                                                                                                                                                                                                                                                                                                                                                        EventData: CommandAndEventMappings[T]

                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                        +EventData | trilium
                                                                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                          Type Alias EventData<T>

                                                                                                                                                                                                                                                                                                                                                                          EventData: CommandAndEventMappings[T]

                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.EventListener.html b/docs/Script API/types/Frontend_Script_API._internal_.EventListener.html similarity index 99% rename from docs/backend_api/types/Frontend_Script_API._internal_.EventListener.html rename to docs/Script API/types/Frontend_Script_API._internal_.EventListener.html index ba76a6dd3..f1896a28f 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.EventListener.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.EventListener.html @@ -1 +1 @@ -EventListener | trilium
                                                                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                            Type Alias EventListener<T>

                                                                                                                                                                                                                                                                                                                                                                            EventListener: { [key in T as `${key}Event`]: (data: EventData<T>) => void }

                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                            +EventListener | trilium
                                                                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                              Type Alias EventListener<T>

                                                                                                                                                                                                                                                                                                                                                                              EventListener: { [key in T as `${key}Event`]: (data: EventData<T>) => void }

                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.EventMappings.html b/docs/Script API/types/Frontend_Script_API._internal_.EventMappings.html similarity index 95% rename from docs/backend_api/types/Frontend_Script_API._internal_.EventMappings.html rename to docs/Script API/types/Frontend_Script_API._internal_.EventMappings.html index 7037248c6..5766ee69f 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.EventMappings.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.EventMappings.html @@ -1,4 +1,4 @@ -EventMappings | trilium
                                                                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                Type Alias EventMappings

                                                                                                                                                                                                                                                                                                                                                                                type EventMappings = {
                                                                                                                                                                                                                                                                                                                                                                                    activeContextChanged: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                    activeNoteChanged: {};
                                                                                                                                                                                                                                                                                                                                                                                    activeScreenChanged: { activeScreen: Screen };
                                                                                                                                                                                                                                                                                                                                                                                    addNewLabel: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                    addNewRelation: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                    apiLogMessages: { messages: string[]; noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                    beforeNoteContextRemove: { ntxIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                    beforeNoteSwitch: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                    cloneNoteIdsTo: { noteIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                    contextsReopened: {
                                                                                                                                                                                                                                                                                                                                                                                        afterNtxId?: string;
                                                                                                                                                                                                                                                                                                                                                                                        mainNtxId: string | null;
                                                                                                                                                                                                                                                                                                                                                                                        ntxId?: string;
                                                                                                                                                                                                                                                                                                                                                                                        tabPosition: number;
                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                    entitiesReloaded: { loadResults: default };
                                                                                                                                                                                                                                                                                                                                                                                    exportPng: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                    exportSvg: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                    frocaReloaded: {};
                                                                                                                                                                                                                                                                                                                                                                                    geoMapCreateChildNote: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                    hoistedNoteChanged: { noteId: string; ntxId: string | null };
                                                                                                                                                                                                                                                                                                                                                                                    initialRenderComplete: {};
                                                                                                                                                                                                                                                                                                                                                                                    newNoteContextCreated: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                    noteContextRemoved: { ntxIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                    noteContextReorder: {
                                                                                                                                                                                                                                                                                                                                                                                        newMainNtxId: string;
                                                                                                                                                                                                                                                                                                                                                                                        ntxIdsInOrder: string[];
                                                                                                                                                                                                                                                                                                                                                                                        oldMainNtxId: string;
                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                    noteDetailRefreshed: { ntxId?: string
                                                                                                                                                                                                                                                                                                                                                                                    | null };
                                                                                                                                                                                                                                                                                                                                                                                    notesReloaded: { noteIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                    noteSwitched: NoteSwitchedContext;
                                                                                                                                                                                                                                                                                                                                                                                    noteSwitchedAndActivated: NoteSwitchedContext;
                                                                                                                                                                                                                                                                                                                                                                                    noteTypeMimeChanged: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                    openBulkActionsDialog: { selectedOrActiveNoteIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                    protectedSessionStarted: {};
                                                                                                                                                                                                                                                                                                                                                                                    readOnlyTemporarilyDisabled: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                    reEvaluateHighlightsListWidgetVisibility: { noteId: string | undefined };
                                                                                                                                                                                                                                                                                                                                                                                    reEvaluateTocWidgetVisibility: { noteId: string | undefined };
                                                                                                                                                                                                                                                                                                                                                                                    refreshData: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                    refreshIncludedNote: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                    refreshNoteList: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                    relationMapCreateChildNote: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                    relationMapResetPanZoom: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                    relationMapResetZoomIn: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                    relationMapResetZoomOut: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                    searchRefreshed: { ntxId?: string | null };
                                                                                                                                                                                                                                                                                                                                                                                    setNoteContext: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                    showAddLinkDialog: { text: string; textTypeWidget: default };
                                                                                                                                                                                                                                                                                                                                                                                    showHighlightsListWidget: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                    showIncludeDialog: { textTypeWidget: default };
                                                                                                                                                                                                                                                                                                                                                                                    showSearchError: { error: string };
                                                                                                                                                                                                                                                                                                                                                                                    showTocWidget: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                    sqlQueryResults: CommandData & { results: SqlExecuteResults };
                                                                                                                                                                                                                                                                                                                                                                                    tabReorder: { ntxIdsInOrder: string[] };
                                                                                                                                                                                                                                                                                                                                                                                    zenModeChanged: { isEnabled: boolean };
                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                activeContextChanged +EventMappings | trilium
                                                                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                  Type Alias EventMappings

                                                                                                                                                                                                                                                                                                                                                                                  type EventMappings = {
                                                                                                                                                                                                                                                                                                                                                                                      activeContextChanged: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                      activeNoteChanged: {};
                                                                                                                                                                                                                                                                                                                                                                                      activeScreenChanged: { activeScreen: Screen };
                                                                                                                                                                                                                                                                                                                                                                                      addNewLabel: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                      addNewRelation: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                      apiLogMessages: { messages: string[]; noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                      beforeNoteContextRemove: { ntxIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                      beforeNoteSwitch: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                      cloneNoteIdsTo: { noteIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                      contextsReopened: {
                                                                                                                                                                                                                                                                                                                                                                                          afterNtxId?: string;
                                                                                                                                                                                                                                                                                                                                                                                          mainNtxId: string | null;
                                                                                                                                                                                                                                                                                                                                                                                          ntxId?: string;
                                                                                                                                                                                                                                                                                                                                                                                          tabPosition: number;
                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                      entitiesReloaded: { loadResults: default };
                                                                                                                                                                                                                                                                                                                                                                                      exportPng: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                      exportSvg: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                      frocaReloaded: {};
                                                                                                                                                                                                                                                                                                                                                                                      geoMapCreateChildNote: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                      hoistedNoteChanged: { noteId: string; ntxId: string | null };
                                                                                                                                                                                                                                                                                                                                                                                      initialRenderComplete: {};
                                                                                                                                                                                                                                                                                                                                                                                      newNoteContextCreated: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                      noteContextRemoved: { ntxIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                      noteContextReorder: {
                                                                                                                                                                                                                                                                                                                                                                                          newMainNtxId: string;
                                                                                                                                                                                                                                                                                                                                                                                          ntxIdsInOrder: string[];
                                                                                                                                                                                                                                                                                                                                                                                          oldMainNtxId: string;
                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                      noteDetailRefreshed: { ntxId?: string
                                                                                                                                                                                                                                                                                                                                                                                      | null };
                                                                                                                                                                                                                                                                                                                                                                                      notesReloaded: { noteIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                      noteSwitched: NoteSwitchedContext;
                                                                                                                                                                                                                                                                                                                                                                                      noteSwitchedAndActivated: NoteSwitchedContext;
                                                                                                                                                                                                                                                                                                                                                                                      noteTypeMimeChanged: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                      openBulkActionsDialog: { selectedOrActiveNoteIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                      protectedSessionStarted: {};
                                                                                                                                                                                                                                                                                                                                                                                      readOnlyTemporarilyDisabled: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                      reEvaluateHighlightsListWidgetVisibility: { noteId: string | undefined };
                                                                                                                                                                                                                                                                                                                                                                                      reEvaluateTocWidgetVisibility: { noteId: string | undefined };
                                                                                                                                                                                                                                                                                                                                                                                      refreshData: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                      refreshIncludedNote: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                      refreshNoteList: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                      relationMapCreateChildNote: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                      relationMapResetPanZoom: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                      relationMapResetZoomIn: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                      relationMapResetZoomOut: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                      searchRefreshed: { ntxId?: string | null };
                                                                                                                                                                                                                                                                                                                                                                                      setNoteContext: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                      showAddLinkDialog: { text: string; textTypeWidget: default };
                                                                                                                                                                                                                                                                                                                                                                                      showHighlightsListWidget: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                      showIncludeDialog: { textTypeWidget: default };
                                                                                                                                                                                                                                                                                                                                                                                      showSearchError: { error: string };
                                                                                                                                                                                                                                                                                                                                                                                      showTocWidget: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                      sqlQueryResults: CommandData & { results: SqlExecuteResults };
                                                                                                                                                                                                                                                                                                                                                                                      tabReorder: { ntxIdsInOrder: string[] };
                                                                                                                                                                                                                                                                                                                                                                                      zenModeChanged: { isEnabled: boolean };
                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                  activeContextChanged activeNoteChanged activeScreenChanged addNewLabel @@ -45,5 +45,5 @@ sqlQueryResults tabReorder zenModeChanged -

                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                  activeContextChanged: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                  activeNoteChanged: {}
                                                                                                                                                                                                                                                                                                                                                                                  activeScreenChanged: { activeScreen: Screen }

                                                                                                                                                                                                                                                                                                                                                                                  Triggered when the CommandMappings.setActiveScreen command is invoked.

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  addNewLabel: CommandData
                                                                                                                                                                                                                                                                                                                                                                                  addNewRelation: CommandData
                                                                                                                                                                                                                                                                                                                                                                                  apiLogMessages: { messages: string[]; noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                  beforeNoteContextRemove: { ntxIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                  beforeNoteSwitch: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                  cloneNoteIdsTo: { noteIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                  contextsReopened: {
                                                                                                                                                                                                                                                                                                                                                                                      afterNtxId?: string;
                                                                                                                                                                                                                                                                                                                                                                                      mainNtxId: string | null;
                                                                                                                                                                                                                                                                                                                                                                                      ntxId?: string;
                                                                                                                                                                                                                                                                                                                                                                                      tabPosition: number;
                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                  entitiesReloaded: { loadResults: default }
                                                                                                                                                                                                                                                                                                                                                                                  exportPng: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  exportSvg: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  frocaReloaded: {}
                                                                                                                                                                                                                                                                                                                                                                                  geoMapCreateChildNote: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  hoistedNoteChanged: { noteId: string; ntxId: string | null }
                                                                                                                                                                                                                                                                                                                                                                                  initialRenderComplete: {}
                                                                                                                                                                                                                                                                                                                                                                                  newNoteContextCreated: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                  noteContextRemoved: { ntxIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                  noteContextReorder: {
                                                                                                                                                                                                                                                                                                                                                                                      newMainNtxId: string;
                                                                                                                                                                                                                                                                                                                                                                                      ntxIdsInOrder: string[];
                                                                                                                                                                                                                                                                                                                                                                                      oldMainNtxId: string;
                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                  noteDetailRefreshed: { ntxId?: string | null }
                                                                                                                                                                                                                                                                                                                                                                                  notesReloaded: { noteIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                  noteSwitched: NoteSwitchedContext
                                                                                                                                                                                                                                                                                                                                                                                  noteSwitchedAndActivated: NoteSwitchedContext
                                                                                                                                                                                                                                                                                                                                                                                  noteTypeMimeChanged: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                  openBulkActionsDialog: { selectedOrActiveNoteIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                  protectedSessionStarted: {}
                                                                                                                                                                                                                                                                                                                                                                                  readOnlyTemporarilyDisabled: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                  reEvaluateHighlightsListWidgetVisibility: { noteId: string | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  reEvaluateTocWidgetVisibility: { noteId: string | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  refreshData: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  refreshIncludedNote: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                  refreshNoteList: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                  relationMapCreateChildNote: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  relationMapResetPanZoom: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  relationMapResetZoomIn: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  relationMapResetZoomOut: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  searchRefreshed: { ntxId?: string | null }
                                                                                                                                                                                                                                                                                                                                                                                  setNoteContext: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                  showAddLinkDialog: { text: string; textTypeWidget: default }
                                                                                                                                                                                                                                                                                                                                                                                  showHighlightsListWidget: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                  showIncludeDialog: { textTypeWidget: default }
                                                                                                                                                                                                                                                                                                                                                                                  showSearchError: { error: string }
                                                                                                                                                                                                                                                                                                                                                                                  showTocWidget: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                  sqlQueryResults: CommandData & { results: SqlExecuteResults }
                                                                                                                                                                                                                                                                                                                                                                                  tabReorder: { ntxIdsInOrder: string[] }
                                                                                                                                                                                                                                                                                                                                                                                  zenModeChanged: { isEnabled: boolean }

                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                  activeContextChangedactiveNoteChangedactiveScreenChangedaddNewLabeladdNewRelationapiLogMessagesbeforeNoteContextRemovebeforeNoteSwitchcloneNoteIdsTocontextsReopenedentitiesReloadedexportPngexportSvgfrocaReloadedgeoMapCreateChildNotehoistedNoteChangedinitialRenderCompletenewNoteContextCreatednoteContextRemovednoteContextReordernoteDetailRefreshednotesReloadednoteSwitchednoteSwitchedAndActivatednoteTypeMimeChangedopenBulkActionsDialogprotectedSessionStartedreadOnlyTemporarilyDisabledreEvaluateHighlightsListWidgetVisibilityreEvaluateTocWidgetVisibilityrefreshDatarefreshIncludedNoterefreshNoteListrelationMapCreateChildNoterelationMapResetPanZoomrelationMapResetZoomInrelationMapResetZoomOutsearchRefreshedsetNoteContextshowAddLinkDialogshowHighlightsListWidgetshowIncludeDialogshowSearchErrorshowTocWidgetsqlQueryResultstabReorderzenModeChanged
                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                  activeContextChanged: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                  activeNoteChanged: {}
                                                                                                                                                                                                                                                                                                                                                                                  activeScreenChanged: { activeScreen: Screen }

                                                                                                                                                                                                                                                                                                                                                                                  Triggered when the CommandMappings.setActiveScreen command is invoked.

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  addNewLabel: CommandData
                                                                                                                                                                                                                                                                                                                                                                                  addNewRelation: CommandData
                                                                                                                                                                                                                                                                                                                                                                                  apiLogMessages: { messages: string[]; noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                  beforeNoteContextRemove: { ntxIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                  beforeNoteSwitch: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                  cloneNoteIdsTo: { noteIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                  contextsReopened: {
                                                                                                                                                                                                                                                                                                                                                                                      afterNtxId?: string;
                                                                                                                                                                                                                                                                                                                                                                                      mainNtxId: string | null;
                                                                                                                                                                                                                                                                                                                                                                                      ntxId?: string;
                                                                                                                                                                                                                                                                                                                                                                                      tabPosition: number;
                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                  entitiesReloaded: { loadResults: default }
                                                                                                                                                                                                                                                                                                                                                                                  exportPng: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  exportSvg: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  frocaReloaded: {}
                                                                                                                                                                                                                                                                                                                                                                                  geoMapCreateChildNote: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  hoistedNoteChanged: { noteId: string; ntxId: string | null }
                                                                                                                                                                                                                                                                                                                                                                                  initialRenderComplete: {}
                                                                                                                                                                                                                                                                                                                                                                                  newNoteContextCreated: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                  noteContextRemoved: { ntxIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                  noteContextReorder: {
                                                                                                                                                                                                                                                                                                                                                                                      newMainNtxId: string;
                                                                                                                                                                                                                                                                                                                                                                                      ntxIdsInOrder: string[];
                                                                                                                                                                                                                                                                                                                                                                                      oldMainNtxId: string;
                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                  noteDetailRefreshed: { ntxId?: string | null }
                                                                                                                                                                                                                                                                                                                                                                                  notesReloaded: { noteIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                  noteSwitched: NoteSwitchedContext
                                                                                                                                                                                                                                                                                                                                                                                  noteSwitchedAndActivated: NoteSwitchedContext
                                                                                                                                                                                                                                                                                                                                                                                  noteTypeMimeChanged: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                  openBulkActionsDialog: { selectedOrActiveNoteIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                  protectedSessionStarted: {}
                                                                                                                                                                                                                                                                                                                                                                                  readOnlyTemporarilyDisabled: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                  reEvaluateHighlightsListWidgetVisibility: { noteId: string | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  reEvaluateTocWidgetVisibility: { noteId: string | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  refreshData: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  refreshIncludedNote: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                  refreshNoteList: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                  relationMapCreateChildNote: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  relationMapResetPanZoom: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  relationMapResetZoomIn: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  relationMapResetZoomOut: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                  searchRefreshed: { ntxId?: string | null }
                                                                                                                                                                                                                                                                                                                                                                                  setNoteContext: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                  showAddLinkDialog: { text: string; textTypeWidget: default }
                                                                                                                                                                                                                                                                                                                                                                                  showHighlightsListWidget: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                  showIncludeDialog: { textTypeWidget: default }
                                                                                                                                                                                                                                                                                                                                                                                  showSearchError: { error: string }
                                                                                                                                                                                                                                                                                                                                                                                  showTocWidget: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                  sqlQueryResults: CommandData & { results: SqlExecuteResults }
                                                                                                                                                                                                                                                                                                                                                                                  tabReorder: { ntxIdsInOrder: string[] }
                                                                                                                                                                                                                                                                                                                                                                                  zenModeChanged: { isEnabled: boolean }

                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                  activeContextChangedactiveNoteChangedactiveScreenChangedaddNewLabeladdNewRelationapiLogMessagesbeforeNoteContextRemovebeforeNoteSwitchcloneNoteIdsTocontextsReopenedentitiesReloadedexportPngexportSvgfrocaReloadedgeoMapCreateChildNotehoistedNoteChangedinitialRenderCompletenewNoteContextCreatednoteContextRemovednoteContextReordernoteDetailRefreshednotesReloadednoteSwitchednoteSwitchedAndActivatednoteTypeMimeChangedopenBulkActionsDialogprotectedSessionStartedreadOnlyTemporarilyDisabledreEvaluateHighlightsListWidgetVisibilityreEvaluateTocWidgetVisibilityrefreshDatarefreshIncludedNoterefreshNoteListrelationMapCreateChildNoterelationMapResetPanZoomrelationMapResetZoomInrelationMapResetZoomOutsearchRefreshedsetNoteContextshowAddLinkDialogshowHighlightsListWidgetshowIncludeDialogshowSearchErrorshowTocWidgetsqlQueryResultstabReorderzenModeChanged
                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.EventNames.html b/docs/Script API/types/Frontend_Script_API._internal_.EventNames.html similarity index 97% rename from docs/backend_api/types/Frontend_Script_API._internal_.EventNames.html rename to docs/Script API/types/Frontend_Script_API._internal_.EventNames.html index b3017f29e..4cacc8acf 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.EventNames.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.EventNames.html @@ -1 +1 @@ -EventNames | trilium
                                                                                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                    Type Alias EventNames

                                                                                                                                                                                                                                                                                                                                                                                    EventNames: CommandNames | EventOnlyNames

                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                    +EventNames | trilium
                                                                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                      Type Alias EventNames

                                                                                                                                                                                                                                                                                                                                                                                      EventNames: CommandNames | EventOnlyNames

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.EventOnlyNames.html b/docs/Script API/types/Frontend_Script_API._internal_.EventOnlyNames.html similarity index 97% rename from docs/backend_api/types/Frontend_Script_API._internal_.EventOnlyNames.html rename to docs/Script API/types/Frontend_Script_API._internal_.EventOnlyNames.html index 569f05bad..beb05e781 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.EventOnlyNames.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.EventOnlyNames.html @@ -1 +1 @@ -EventOnlyNames | trilium
                                                                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                        Type Alias EventOnlyNames

                                                                                                                                                                                                                                                                                                                                                                                        EventOnlyNames: keyof EventMappings

                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                        +EventOnlyNames | trilium
                                                                                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                          Type Alias EventOnlyNames

                                                                                                                                                                                                                                                                                                                                                                                          EventOnlyNames: keyof EventMappings

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.Func.html b/docs/Script API/types/Frontend_Script_API._internal_.Func.html similarity index 98% rename from docs/backend_api/types/Frontend_Script_API._internal_.Func.html rename to docs/Script API/types/Frontend_Script_API._internal_.Func.html index 9b6561002..289cb328e 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.Func.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.Func.html @@ -1 +1 @@ -Func | trilium
                                                                                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Func

                                                                                                                                                                                                                                                                                                                                                                                            Func: ((...args: unknown[]) => unknown) | string

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                            +Func | trilium
                                                                                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Func

                                                                                                                                                                                                                                                                                                                                                                                              Func: ((...args: unknown[]) => unknown) | string

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.GetTextEditorCallback.html b/docs/Script API/types/Frontend_Script_API._internal_.GetTextEditorCallback.html similarity index 99% rename from docs/backend_api/types/Frontend_Script_API._internal_.GetTextEditorCallback.html rename to docs/Script API/types/Frontend_Script_API._internal_.GetTextEditorCallback.html index 442c8d1ec..f92fd0639 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.GetTextEditorCallback.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.GetTextEditorCallback.html @@ -1 +1 @@ -GetTextEditorCallback | trilium
                                                                                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                Type Alias GetTextEditorCallback

                                                                                                                                                                                                                                                                                                                                                                                                GetTextEditorCallback: (editor: TextEditor) => void

                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                +GetTextEditorCallback | trilium
                                                                                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias GetTextEditorCallback

                                                                                                                                                                                                                                                                                                                                                                                                  GetTextEditorCallback: (editor: TextEditor) => void

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.Handler.html b/docs/Script API/types/Frontend_Script_API._internal_.Handler.html similarity index 99% rename from docs/backend_api/types/Frontend_Script_API._internal_.Handler.html rename to docs/Script API/types/Frontend_Script_API._internal_.Handler.html index a1a10c3d4..d644ce71b 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.Handler.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.Handler.html @@ -1 +1 @@ -Handler | trilium
                                                                                                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Handler

                                                                                                                                                                                                                                                                                                                                                                                                    Handler: (
                                                                                                                                                                                                                                                                                                                                                                                                        e: TriggeredEvent<
                                                                                                                                                                                                                                                                                                                                                                                                            ElementType
                                                                                                                                                                                                                                                                                                                                                                                                            | Element,
                                                                                                                                                                                                                                                                                                                                                                                                            string,
                                                                                                                                                                                                                                                                                                                                                                                                            ElementType | Element,
                                                                                                                                                                                                                                                                                                                                                                                                            ElementType | Element,
                                                                                                                                                                                                                                                                                                                                                                                                        >,
                                                                                                                                                                                                                                                                                                                                                                                                    ) => void

                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                    +Handler | trilium
                                                                                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Handler

                                                                                                                                                                                                                                                                                                                                                                                                      Handler: (
                                                                                                                                                                                                                                                                                                                                                                                                          e: TriggeredEvent<
                                                                                                                                                                                                                                                                                                                                                                                                              ElementType
                                                                                                                                                                                                                                                                                                                                                                                                              | Element,
                                                                                                                                                                                                                                                                                                                                                                                                              string,
                                                                                                                                                                                                                                                                                                                                                                                                              ElementType | Element,
                                                                                                                                                                                                                                                                                                                                                                                                              ElementType | Element,
                                                                                                                                                                                                                                                                                                                                                                                                          >,
                                                                                                                                                                                                                                                                                                                                                                                                      ) => void

                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.LabelType.html b/docs/Script API/types/Frontend_Script_API._internal_.LabelType.html similarity index 98% rename from docs/backend_api/types/Frontend_Script_API._internal_.LabelType.html rename to docs/Script API/types/Frontend_Script_API._internal_.LabelType.html index 932131b39..48db56c59 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.LabelType.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.LabelType.html @@ -1 +1 @@ -LabelType | trilium
                                                                                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias LabelType

                                                                                                                                                                                                                                                                                                                                                                                                        LabelType: "text" | "number" | "boolean" | "date" | "datetime" | "time" | "url"

                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                        +LabelType | trilium
                                                                                                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias LabelType

                                                                                                                                                                                                                                                                                                                                                                                                          LabelType: "text" | "number" | "boolean" | "date" | "datetime" | "time" | "url"

                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.Multiplicity.html b/docs/Script API/types/Frontend_Script_API._internal_.Multiplicity.html similarity index 97% rename from docs/backend_api/types/Frontend_Script_API._internal_.Multiplicity.html rename to docs/Script API/types/Frontend_Script_API._internal_.Multiplicity.html index c16ee2eac..b91978e5f 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.Multiplicity.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.Multiplicity.html @@ -1 +1 @@ -Multiplicity | trilium
                                                                                                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Multiplicity

                                                                                                                                                                                                                                                                                                                                                                                                            Multiplicity: "single" | "multi"

                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                            +Multiplicity | trilium
                                                                                                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Multiplicity

                                                                                                                                                                                                                                                                                                                                                                                                              Multiplicity: "single" | "multi"

                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.NoteType.html b/docs/Script API/types/Frontend_Script_API._internal_.NoteType.html similarity index 99% rename from docs/backend_api/types/Frontend_Script_API._internal_.NoteType.html rename to docs/Script API/types/Frontend_Script_API._internal_.NoteType.html index 8d6dabb3b..1d5ab6fdb 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.NoteType.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.NoteType.html @@ -1,4 +1,4 @@ NoteType | trilium
                                                                                                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias NoteType

                                                                                                                                                                                                                                                                                                                                                                                                                NoteType:
                                                                                                                                                                                                                                                                                                                                                                                                                    | "file"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "image"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "search"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "noteMap"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "launcher"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "doc"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "contentWidget"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "text"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "relationMap"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "render"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "canvas"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "mermaid"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "book"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "webView"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "code"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "mindMap"
                                                                                                                                                                                                                                                                                                                                                                                                                    | "geoMap"

                                                                                                                                                                                                                                                                                                                                                                                                                There are many different Note types, some of which are entirely opaque to the end user. Those types should be used only for checking against, they are not for direct use.

                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.PromptShownDialogCallback.html b/docs/Script API/types/Frontend_Script_API._internal_.PromptShownDialogCallback.html similarity index 97% rename from docs/backend_api/types/Frontend_Script_API._internal_.PromptShownDialogCallback.html rename to docs/Script API/types/Frontend_Script_API._internal_.PromptShownDialogCallback.html index 6ca14319a..cbd66efd1 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.PromptShownDialogCallback.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.PromptShownDialogCallback.html @@ -1 +1 @@ -PromptShownDialogCallback | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias PromptShownDialogCallback

                                                                                                                                                                                                                                                                                                                                                                                                                  PromptShownDialogCallback: ((callback: ShownCallbackData) => void) | null

                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                  +PromptShownDialogCallback | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PromptShownDialogCallback

                                                                                                                                                                                                                                                                                                                                                                                                                    PromptShownDialogCallback: ((callback: ShownCallbackData) => void) | null

                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.Required.html b/docs/Script API/types/Frontend_Script_API._internal_.Required.html similarity index 100% rename from docs/backend_api/types/Frontend_Script_API._internal_.Required.html rename to docs/Script API/types/Frontend_Script_API._internal_.Required.html diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.Screen.html b/docs/Script API/types/Frontend_Script_API._internal_.Screen.html similarity index 98% rename from docs/backend_api/types/Frontend_Script_API._internal_.Screen.html rename to docs/Script API/types/Frontend_Script_API._internal_.Screen.html index 666bd80b7..26539d341 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.Screen.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.Screen.html @@ -1 +1 @@ -Screen | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Screen

                                                                                                                                                                                                                                                                                                                                                                                                                      Screen: "detail" | "tree"

                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                      +Screen | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Screen

                                                                                                                                                                                                                                                                                                                                                                                                                        Screen: "detail" | "tree"

                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.SqlExecuteResults.html b/docs/Script API/types/Frontend_Script_API._internal_.SqlExecuteResults.html similarity index 98% rename from docs/backend_api/types/Frontend_Script_API._internal_.SqlExecuteResults.html rename to docs/Script API/types/Frontend_Script_API._internal_.SqlExecuteResults.html index 5cf0f9377..74d472362 100644 --- a/docs/backend_api/types/Frontend_Script_API._internal_.SqlExecuteResults.html +++ b/docs/Script API/types/Frontend_Script_API._internal_.SqlExecuteResults.html @@ -1 +1 @@ -SqlExecuteResults | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias SqlExecuteResults

                                                                                                                                                                                                                                                                                                                                                                                                                          SqlExecuteResults: string[][][]

                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                          +SqlExecuteResults | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias SqlExecuteResults

                                                                                                                                                                                                                                                                                                                                                                                                                            SqlExecuteResults: string[][][]

                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.TypeOrArray.html b/docs/Script API/types/Frontend_Script_API._internal_.TypeOrArray.html similarity index 100% rename from docs/backend_api/types/Frontend_Script_API._internal_.TypeOrArray.html rename to docs/Script API/types/Frontend_Script_API._internal_.TypeOrArray.html diff --git a/docs/backend_api/variables/Backend_Script_API._internal_.Object.html b/docs/Script API/variables/Backend_Script_API._internal_.Object.html similarity index 100% rename from docs/backend_api/variables/Backend_Script_API._internal_.Object.html rename to docs/Script API/variables/Backend_Script_API._internal_.Object.html diff --git a/docs/backend_api/variables/Backend_Script_API._internal_.node_modules__types_xml2js.defaults.html b/docs/Script API/variables/Backend_Script_API._internal_.node_modules__types_xml2js.defaults.html similarity index 100% rename from docs/backend_api/variables/Backend_Script_API._internal_.node_modules__types_xml2js.defaults.html rename to docs/Script API/variables/Backend_Script_API._internal_.node_modules__types_xml2js.defaults.html diff --git a/docs/backend_api/variables/Backend_Script_API.api.html b/docs/Script API/variables/Backend_Script_API.api.html similarity index 98% rename from docs/backend_api/variables/Backend_Script_API.api.html rename to docs/Script API/variables/Backend_Script_API.api.html index 6355b4263..3109b9a09 100644 --- a/docs/backend_api/variables/Backend_Script_API.api.html +++ b/docs/Script API/variables/Backend_Script_API.api.html @@ -1,2 +1,2 @@ api | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                              Variable apiConst

                                                                                                                                                                                                                                                                                                                                                                                                                              api: Api = ...

                                                                                                                                                                                                                                                                                                                                                                                                                              The code api global variable allows access to the backend script API, which is documented in Api.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/Script API/variables/Frontend_Script_API.api.html b/docs/Script API/variables/Frontend_Script_API.api.html new file mode 100644 index 000000000..fee7270e9 --- /dev/null +++ b/docs/Script API/variables/Frontend_Script_API.api.html @@ -0,0 +1 @@ +api | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                Variable apiConst

                                                                                                                                                                                                                                                                                                                                                                                                                                api: Api = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/variables/Frontend_Script_API.api.html b/docs/backend_api/variables/Frontend_Script_API.api.html deleted file mode 100644 index c4083bd73..000000000 --- a/docs/backend_api/variables/Frontend_Script_API.api.html +++ /dev/null @@ -1 +0,0 @@ -api | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable apiConst

                                                                                                                                                                                                                                                                                                                                                                                                                                  api: Api = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/frontend_api/BasicWidget.html b/docs/frontend_api/BasicWidget.html deleted file mode 100644 index 2f4f0ea87..000000000 --- a/docs/frontend_api/BasicWidget.html +++ /dev/null @@ -1,1077 +0,0 @@ - - - - - JSDoc: Class: BasicWidget - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Class: BasicWidget

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  BasicWidget()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  This is the base widget for all other widgets. - -For information on using widgets, see the tutorial widget_basics.
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  new BasicWidget()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  css(name, value)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Sets the CSS attribute of the given name to the given value. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - the name of the CSS attribute to set (e.g. `padding-left`).
                                                                                                                                                                                                                                                                                                                                                                                                                                  value - - -string - - - - the value of the CSS attribute to set (e.g. `12px`).
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - self for chaining. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  cssBlock(block) → {this}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Accepts a string of CSS to add with the widget. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  block - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - for chaining -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -this - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  doRender()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Method used for rendering the widget. - -Your class should override this method. -The method is expected to create a this.$widget containing jQuery object -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  isEnabled()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to `false` will cause the widget not to be displayed, however it will still be available on the DOM but hidden. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - whether the widget is enabled. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  optChild(condition, …components)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Conditionally adds the given components as children to this component. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  condition - - -boolean - - - - - - - - - - whether to add the components.
                                                                                                                                                                                                                                                                                                                                                                                                                                  components - - -any - - - - - - - - - - <repeatable>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		the components to be added as children to this component provided the condition is truthy.
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - self for chaining. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  optCss(condition, name, value)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  condition - - -boolean - - - - `true` in order to apply the CSS, `false` to ignore it.
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - the name of the CSS attribute to set (e.g. `padding-left`).
                                                                                                                                                                                                                                                                                                                                                                                                                                  value - - -string - - - - the value of the CSS attribute to set (e.g. `12px`).
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - self for chaining. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/FAttachment.html b/docs/frontend_api/FAttachment.html deleted file mode 100644 index ec11ac7e3..000000000 --- a/docs/frontend_api/FAttachment.html +++ /dev/null @@ -1,1067 +0,0 @@ - - - - - JSDoc: Class: FAttachment - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Class: FAttachment

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  FAttachment()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Attachment is a file directly tied into a note without -being a hidden child.
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  new FAttachment()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Members

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  attachmentId :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  contentLength :int

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - optionally added to the entity -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -int - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  dateModified :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  froca :Froca

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -Froca - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  mime :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  ownerId :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  role :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  title :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  utcDateModified :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  utcDateScheduledForErasureSince :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  (async) getBlob() → {FBlob}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -FBlob - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getNote() → {FNote}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -FNote - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/FAttribute.html b/docs/frontend_api/FAttribute.html deleted file mode 100644 index eb7651e65..000000000 --- a/docs/frontend_api/FAttribute.html +++ /dev/null @@ -1,927 +0,0 @@ - - - - - JSDoc: Class: FAttribute - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Class: FAttribute

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  FAttribute()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Attribute is an abstract concept which has two real uses - label (key - value pair) -and relation (representing named relationship between source and target note)
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  new FAttribute()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Members

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  attributeId :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  froca :Froca

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -Froca - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  isInheritable :boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -boolean - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  name :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  noteId :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  position :int

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -int - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  type :AttributeType

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  value :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getNote() → {FNote}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -FNote - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  (async) getTargetNote() → {Promise.<FNote>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<FNote> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/FBranch.html b/docs/frontend_api/FBranch.html deleted file mode 100644 index 6528e8a6c..000000000 --- a/docs/frontend_api/FBranch.html +++ /dev/null @@ -1,1139 +0,0 @@ - - - - - JSDoc: Class: FBranch - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Class: FBranch

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  FBranch()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  new FBranch()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Members

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  branchId :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - primary key -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  froca :Froca

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -Froca - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  fromSearchNote :boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -boolean - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  isExpanded :boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -boolean - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  noteId :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  notePosition :int

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -int - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  parentNoteId :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  prefix :string

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  (async) getNote() → {FNote}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -FNote - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getNoteFromCache() → {FNote}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -FNote - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  (async) getParentNote() → {FNote}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -FNote - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  isTopLevel() → {boolean}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - true if it's top level, meaning its parent is the root note -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -boolean - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/FNote.html b/docs/frontend_api/FNote.html deleted file mode 100644 index 3bf4e5b09..000000000 --- a/docs/frontend_api/FNote.html +++ /dev/null @@ -1,8815 +0,0 @@ - - - - - JSDoc: Class: FNote - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Class: FNote

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  FNote(froca, row)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Note is the main node and concept in Trilium.
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  new FNote(froca, row)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDefaultDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDefaultDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - label name
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - label if it exists, null otherwise -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -FAttribute - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getLabelValue(name) → {string}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - label name
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - label value if label exists, null otherwise -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - label name
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - label if it exists, null otherwise -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -FAttribute - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getOwnedLabelValue(name) → {string}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - label name
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - label value if label exists, null otherwise -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - relation name
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - relation if it exists, null otherwise -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -FAttribute - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getOwnedRelationValue(name) → {string}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - relation name
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - relation value if relation exists, null otherwise -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - relation name
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - relation if it exists, null otherwise -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -FAttribute - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - - - <optional>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		relation name to filter
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<Array.<FNote>> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getRelationValue(name) → {string}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - relation name
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - relation value if relation exists, null otherwise -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDefaultDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - label name
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - true if label exists (including inherited) -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -boolean - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  hasOwnedAttribute(type, name) → {boolean}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - label name
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - true if label exists (excluding inherited) -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -boolean - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  hasOwnedRelation(name) → {boolean}

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

                                                                                                                                                                                                                                                                                                                                                                                                                                  hasRelation(name) → {boolean}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  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:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - label name
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - true if label exists (including inherited) and does not have "false" value. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -boolean - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/FrontendScriptApi.html b/docs/frontend_api/FrontendScriptApi.html deleted file mode 100644 index 6114b21a1..000000000 --- a/docs/frontend_api/FrontendScriptApi.html +++ /dev/null @@ -1,8739 +0,0 @@ - - - - - JSDoc: Class: FrontendScriptApi - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Class: FrontendScriptApi

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  FrontendScriptApi()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  new FrontendScriptApi()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                  This is the main frontend API interface for scripts. All the properties and methods are published in the "api" object -available in the JS frontend notes. You can use e.g. api.showMessage(api.startNote.title);

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Members

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  $container :jQuery

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Container of all the rendered script content -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -jQuery - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  BasicWidget :BasicWidget

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  NoteContextAwareWidget :NoteContextAwareWidget

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  RightPanelWidget :RightPanelWidget

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated:
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - use api.createLink() instead
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  currentNote :FNote

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Note where the script is currently executing, i.e. the note where the currently executing source code is written. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  dayjs :dayjs

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - day.js library for date manipulation. -See https://day.js.org for documentation -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -dayjs - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  See:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  originEntity :object|null

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Entity whose event triggered this execution. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -object -| - -null - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  startNote :FNote

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Note where the script started executing, i.e., the (event) entrypoint of the current script execution. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  activateNewNote(notePath) → {Promise.<void>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Activates newly created note. Compared to this.activateNote() also makes sure that frontend has been fully synced. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  notePath - - -string - - - - (or noteId)
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<void> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  activateNote(notePath) → {Promise.<void>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Activates note in the tree and in the note detail. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  notePath - - -string - - - - (or noteId)
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<void> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  addButtonToToolbar(opts)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Adds a new launcher to the launchbar. If the launcher (id) already exists, it will be updated. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  opts - - -object - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  title - - -string - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  action - - -function - - - - - - - - - - callback handling the click on the button
                                                                                                                                                                                                                                                                                                                                                                                                                                  id - - -string - - - - - - <optional>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		id of the button, used to identify the old instances of this button to be replaced - ID is optional because of BC, but not specifying it is deprecated. ID can be alphanumeric only.
                                                                                                                                                                                                                                                                                                                                                                                                                                  icon - - -string - - - - - - <optional>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		name of the boxicon to be used (e.g. "time" for "bx-time" icon)
                                                                                                                                                                                                                                                                                                                                                                                                                                  shortcut - - -string - - - - - - <optional>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		keyboard shortcut for the button, e.g. "alt+t"
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated:
                                                                                                                                                                                                                                                                                                                                                                                                                                  • you can now create/modify launchers in the top-left Menu -> Configure Launchbar - for special needs there's also backend API's createOrUpdateLauncher()
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  addTextToActiveContextEditor(text)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Adds given text to the editor cursor -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  text - - -string - - - - this must be clear text, HTML is not supported.
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  bindGlobalShortcut(keyboardShortcut, handler, namespaceopt) → {Promise.<void>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  keyboardShortcut - - -string - - - - - - - - - - e.g. "ctrl+shift+a"
                                                                                                                                                                                                                                                                                                                                                                                                                                  handler - - -function - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  namespace - - -string - - - - - - <optional>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		specify namespace of the handler for the cases where call for bind may be repeated. - If a handler with this ID exists, it's replaced by the new handler.
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<void> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Create a note link (jQuery object) for given note. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  notePath - - -string - - - - - - - - - - (or noteId)
                                                                                                                                                                                                                                                                                                                                                                                                                                  params - - -object - - - - - - <optional>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		-
                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDefaultDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  showTooltip - - -boolean - - - - - - <optional>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		- - true - - enable/disable tooltip on the link
                                                                                                                                                                                                                                                                                                                                                                                                                                  showNotePath - - -boolean - - - - - - <optional>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		- - false - - show also whole note's path as part of the link
                                                                                                                                                                                                                                                                                                                                                                                                                                  showNoteIcon - - -boolean - - - - - - <optional>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		- - false - - show also note icon before the title
                                                                                                                                                                                                                                                                                                                                                                                                                                  title - - -string - - - - - - <optional>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		- - custom link tile with note's title as default
                                                                                                                                                                                                                                                                                                                                                                                                                                  title= - - -string - - - - - - <optional>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		- - custom link tile with note's title as default
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - jQuery element with the link (wrapped in ) -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -jQuery - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  formatDateISO(date) → {string}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  date - - -Date - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - date in YYYY-MM-DD format -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  formatNoteSize(size) → {string}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  size - - -int - - - - in bytes
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated:
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - use api.formatSize()
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - formatted string -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  formatSize(size) → {string}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  size - - -int - - - - in bytes
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - formatted string -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getActiveContext() → {NoteContext}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - returns active context (split) -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -NoteContext - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getActiveContextCodeEditor() → {Promise.<CodeMirror>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - See https://codemirror.net/doc/manual.html#api -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - instance of CodeMirror -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<CodeMirror> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getActiveContextNote() → {FNote}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - active note (loaded into center pane) -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -FNote - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getActiveContextNotePath() → {Promise.<(string|null)>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - returns a note path of active note or null if there isn't active note -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<(string|null)> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getActiveContextTextEditor() → {Promise.<BalloonEditor>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - See https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editor-Editor.html for documentation on the returned instance. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - instance of CKEditor -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<BalloonEditor> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getActiveMainContext() → {NoteContext}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - returns active main context (first split in a tab, represents the tab as a whole) -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -NoteContext - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getActiveNoteDetailWidget() → {Promise.<NoteDetailWidget>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Get access to the widget handling note detail. Methods like `getWidgetType()` and `getTypeWidget()` to get to the -implementation of actual widget type. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<NoteDetailWidget> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getComponentByEl(el) → {Component}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Returns component which owns the given DOM element (the nearest parent component in DOM tree) -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  el - - -Element - - - - DOM element
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Component - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getDayNote(date) → {Promise.<FNote>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Returns day note for a given date. If it doesn't exist, it is automatically created. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  date - - -string - - - - e.g. "2019-04-29"
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<FNote> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getInstanceName() → {string}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Instance name identifies particular Trilium instance. It can be useful for scripts -if some action needs to happen on only one specific instance. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getMainNoteContexts() → {Array.<NoteContext>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - returns all main contexts representing tabs -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Array.<NoteContext> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getMonthNote(month) → {Promise.<FNote>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Returns month-note. If it doesn't exist, it is automatically created. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  month - - -string - - - - e.g. "2019-04"
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<FNote> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getNote(noteId) → {Promise.<FNote>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Returns note by given noteId. If note is missing from the cache, it's loaded. -* -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  noteId - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<FNote> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getNoteContexts() → {Array.<NoteContext>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - returns all note contexts (splits) in all tabs -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Array.<NoteContext> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getNotes(noteIds, silentNotFoundErroropt) → {Promise.<Array.<FNote>>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Returns list of notes. If note is missing from the cache, it's loaded. - -This is often used to bulk-fill the cache with notes which would have to be picked one by one -otherwise (by e.g. createLink()) -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  noteIds - - -Array.<string> - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  silentNotFoundError - - -boolean - - - - - - <optional>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		don't report error if the note is not found
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<Array.<FNote>> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getTodayNote() → {Promise.<FNote>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Returns date-note for today. If it doesn't exist, it is automatically created. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<FNote> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getWeekFirstDayNote(date) → {Promise.<FNote>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Returns day note for the first date of the week of the given date. If it doesn't exist, it is automatically created. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  date - - -string - - - - e.g. "2019-04-29"
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<FNote> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getYearNote(year) → {Promise.<FNote>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Returns year-note. If it doesn't exist, it is automatically created. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  year - - -string - - - - e.g. "2019"
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<FNote> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  log(message) → {void}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Log given message to the log pane in UI -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  message - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -void - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  openSplitWithNote(notePath, activate) → {Promise.<void>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Open a note in a new split. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  notePath - - -string - - - - (or noteId)
                                                                                                                                                                                                                                                                                                                                                                                                                                  activate - - -boolean - - - - set to true to activate the new split, false to stay on the current split
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<void> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  openTabWithNote(notePath, activate) → {Promise.<void>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Open a note in a new tab. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  notePath - - -string - - - - (or noteId)
                                                                                                                                                                                                                                                                                                                                                                                                                                  activate - - -boolean - - - - set to true to activate the new tab, false to stay on the current tab
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<void> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  parseDate(str) → {Date}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  str - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - parsed object -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Date - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  protectNote(noteId, protect) → {Promise.<void>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  noteId - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  protect - - -boolean - - - - true to protect note, false to unprotect
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<void> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  protectSubTree(noteId, protect) → {Promise.<void>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  noteId - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  protect - - -boolean - - - - true to protect subtree, false to unprotect
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<void> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  randomString(length) → {string}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Return randomly generated string of given length. This random string generation is NOT cryptographically secure. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  length - - -int - - - - of the string
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - random string -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -string - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  refreshIncludedNote(includedNoteId) → {Promise.<void>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - This will refresh all currently opened notes which have included note specified in the parameter -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  includedNoteId - - noteId of the included note
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<void> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  reloadNotes(noteIds)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Update frontend tree (note) cache from the backend. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  noteIds - - -Array.<string> - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  runAsyncOnBackendWithManualTransactionHandling(func, params) → {Promise.<*>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Executes given anonymous function on the backend. -Internally this serializes the anonymous function into string and sends it to backend via AJAX. -This function is meant for advanced needs where an async function is necessary. -In this case, the automatic request-scoped transaction management is not applied, -and you need to manually define transaction via api.transactional(). - -If you have a synchronous function, please use api.runOnBackend(). -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  func - - -function -| - -string - - - - (synchronous) function to be executed on the backend
                                                                                                                                                                                                                                                                                                                                                                                                                                  params - - -Array.<?> - - - - list of parameters to the anonymous function to be sent to backend
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - return value of the executed function on the backend -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<*> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  runOnBackend(func, params) → {Promise.<*>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Executes given anonymous function on the backend. -Internally this serializes the anonymous function into string and sends it to backend via AJAX. -Please make sure that the supplied function is synchronous. Only sync functions will work correctly -with transaction management. If you really know what you're doing, you can call api.runAsyncOnBackendWithManualTransactionHandling() -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  func - - -function -| - -string - - - - (synchronous) function to be executed on the backend
                                                                                                                                                                                                                                                                                                                                                                                                                                  params - - -Array.<?> - - - - list of parameters to the anonymous function to be sent to backend
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - return value of the executed function on the backend -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<*> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  searchForNote(searchString) → {Promise.<(FNote|null)>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - This is a powerful search method - you can search by attributes and their values, e.g.: -"#dateModified =* MONTH AND #log". See full documentation for all options at: https://triliumnext.github.io/Docs/Wiki/search.html -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  searchString - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<(FNote|null)> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  searchForNotes(searchString) → {Promise.<Array.<FNote>>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - This is a powerful search method - you can search by attributes and their values, e.g.: -"#dateModified =* MONTH AND #log". See full documentation for all options at: https://triliumnext.github.io/Docs/Wiki/search.html -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  searchString - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<Array.<FNote>> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  setHoistedNoteId(noteId) → {Promise.<void>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Hoist note in the current tab. See https://triliumnext.github.io/Docs/Wiki/note-hoisting.html -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  noteId - - -string - - - - set hoisted note. 'root' will effectively unhoist
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<void> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  setupElementTooltip($el) → {Promise.<void>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  $el - - -object - - - - jquery object on which to set up the tooltip
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<void> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  showConfirmDialog(message) → {Promise.<boolean>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Show confirm dialog to the user. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  message - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - promise resolving to true if the user confirmed -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<boolean> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  showError(message)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Show an error toast message to the user. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  message - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  showInfoDialog(message) → {Promise}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Show an info dialog to the user. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  message - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  showMessage(message)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Show an info toast message to the user. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  message - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  showPromptDialog(props) → {Promise.<string>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Show prompt dialog to the user. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  props - - -object - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  title - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  message - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  defaultValue - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - promise resolving to the answer provided by the user -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<string> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  triggerCommand(name, data)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Trigger command. This is a very low-level API which should be avoided if possible. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  data - - -object - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  triggerEvent(name, data)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Trigger event. This is a very low-level API which should be avoided if possible. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  data - - -object - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  waitUntilSynced() → {Promise.<void>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Trilium runs in a backend and frontend process, when something is changed on the backend from a script, -frontend will get asynchronously synchronized. - -This method returns a promise which resolves once all the backend -> frontend synchronization is finished. -Typical use case is when a new note has been created, we should wait until it is synced into frontend and only then activate it. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<void> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/NoteContextAwareWidget.html b/docs/frontend_api/NoteContextAwareWidget.html deleted file mode 100644 index 0bcf62203..000000000 --- a/docs/frontend_api/NoteContextAwareWidget.html +++ /dev/null @@ -1,1591 +0,0 @@ - - - - - JSDoc: Class: NoteContextAwareWidget - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Class: NoteContextAwareWidget

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  NoteContextAwareWidget()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  This widget allows for changing and updating depending on the active note.
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  new NoteContextAwareWidget()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Extends

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Members

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  hoistedNoteId

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  note

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  noteContext :NoteContext

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -NoteContext - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  noteId

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  notePath

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  css(name, value)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Sets the CSS attribute of the given name to the given value. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - the name of the CSS attribute to set (e.g. `padding-left`).
                                                                                                                                                                                                                                                                                                                                                                                                                                  value - - -string - - - - the value of the CSS attribute to set (e.g. `12px`).
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Inherited From:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - self for chaining. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  cssBlock(block) → {this}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Accepts a string of CSS to add with the widget. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  block - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Inherited From:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - for chaining -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -this - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  doRender()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Method used for rendering the widget. - -Your class should override this method. -The method is expected to create a this.$widget containing jQuery object -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Inherited From:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  isEnabled() → {boolean}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to `false` will cause the widget not to be displayed, however it will still be available on the DOM but hidden. - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  -If the widget is not enabled, it will not receive `refreshWithNote` updates. -

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - true when an active note exists -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -boolean - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  optChild(condition, …components)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Conditionally adds the given components as children to this component. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  condition - - -boolean - - - - - - - - - - whether to add the components.
                                                                                                                                                                                                                                                                                                                                                                                                                                  components - - -any - - - - - - - - - - <repeatable>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		the components to be added as children to this component provided the condition is truthy.
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Inherited From:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - self for chaining. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  optCss(condition, name, value)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  condition - - -boolean - - - - `true` in order to apply the CSS, `false` to ignore it.
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - the name of the CSS attribute to set (e.g. `padding-left`).
                                                                                                                                                                                                                                                                                                                                                                                                                                  value - - -string - - - - the value of the CSS attribute to set (e.g. `12px`).
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Inherited From:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - self for chaining. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  (async) refreshWithNote(note) → {Promise.<void>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Override this method to be able to refresh your -widget with each note. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  note - - -FNote - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<void> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/RightPanelWidget.html b/docs/frontend_api/RightPanelWidget.html deleted file mode 100644 index abfc3657b..000000000 --- a/docs/frontend_api/RightPanelWidget.html +++ /dev/null @@ -1,1796 +0,0 @@ - - - - - JSDoc: Class: RightPanelWidget - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Class: RightPanelWidget

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  RightPanelWidget()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  This widget manages rendering panels in the right-hand pane.
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  new RightPanelWidget()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Extends

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Members

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  hoistedNoteId

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  note

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  noteContext :NoteContext

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -NoteContext - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  noteId

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  notePath

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  widgetTitle

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Title to show in the panel. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  css(name, value)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Sets the CSS attribute of the given name to the given value. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - the name of the CSS attribute to set (e.g. `padding-left`).
                                                                                                                                                                                                                                                                                                                                                                                                                                  value - - -string - - - - the value of the CSS attribute to set (e.g. `12px`).
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - self for chaining. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  cssBlock(block) → {this}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Accepts a string of CSS to add with the widget. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  block - - -string - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - for chaining -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -this - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  doRender()

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Do not override this method unless you know what you're doing. -Do not override this method unless you know what you're doing. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  (async) doRenderBody() → {Promise|undefined}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Method used for rendering the body of the widget (via existing this.$body) - -Your class should override this method. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - if widget needs async operation to initialize, it can return a Promise -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise -| - -undefined - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  isEnabled() → {boolean}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to `false` will cause the widget not to be displayed, however it will still be available on the DOM but hidden. - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  -If the widget is not enabled, it will not receive `refreshWithNote` updates. -

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - true when an active note exists -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -boolean - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  optChild(condition, …components)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Conditionally adds the given components as children to this component. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  condition - - -boolean - - - - - - - - - - whether to add the components.
                                                                                                                                                                                                                                                                                                                                                                                                                                  components - - -any - - - - - - - - - - <repeatable>
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -                                                                                                                                                                                                                                                                                                                                                                                                                                   		the components to be added as children to this component provided the condition is truthy.
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - self for chaining. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  optCss(condition, name, value)

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  condition - - -boolean - - - - `true` in order to apply the CSS, `false` to ignore it.
                                                                                                                                                                                                                                                                                                                                                                                                                                  name - - -string - - - - the name of the CSS attribute to set (e.g. `padding-left`).
                                                                                                                                                                                                                                                                                                                                                                                                                                  value - - -string - - - - the value of the CSS attribute to set (e.g. `12px`).
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - self for chaining. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  (async) refreshWithNote(note) → {Promise.<void>}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Override this method to be able to refresh your -widget with each note. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  note - - -FNote - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -Promise.<void> - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/entities_fattachment.js.html b/docs/frontend_api/entities_fattachment.js.html deleted file mode 100644 index ccc598a50..000000000 --- a/docs/frontend_api/entities_fattachment.js.html +++ /dev/null @@ -1,102 +0,0 @@ - - - - - JSDoc: Source: entities/fattachment.js - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Source: entities/fattachment.js

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - 
                                                                                                                                                                                                                                                                                                                                                                                                                                  /**
- * Attachment is a file directly tied into a note without
- * being a hidden child.
- */
-class FAttachment {
-    constructor(froca, row) {
-        /** @type {Froca} */
-        this.froca = froca;
-
-        this.update(row);
-    }
-
-    update(row) {
-        /** @type {string} */
-        this.attachmentId = row.attachmentId;
-        /** @type {string} */
-        this.ownerId = row.ownerId;
-        /** @type {string} */
-        this.role = row.role;
-        /** @type {string} */
-        this.mime = row.mime;
-        /** @type {string} */
-        this.title = row.title;
-        /** @type {string} */
-        this.dateModified = row.dateModified;
-        /** @type {string} */
-        this.utcDateModified = row.utcDateModified;
-        /** @type {string} */
-        this.utcDateScheduledForErasureSince = row.utcDateScheduledForErasureSince;
-
-        /**
-         * optionally added to the entity 
-         * @type {int}
-         */
-        this.contentLength = row.contentLength;
-
-        this.froca.attachments[this.attachmentId] = this;
-    }
-
-    /** @returns {FNote} */
-    getNote() {
-        return this.froca.notes[this.ownerId];
-    }
-
-    /** @return {FBlob} */
-    async getBlob() {
-        return await this.froca.getBlob('attachments', this.attachmentId);
-    }
-}
-
-export default FAttachment;
-
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - diff --git a/docs/frontend_api/entities_fattribute.js.html b/docs/frontend_api/entities_fattribute.js.html deleted file mode 100644 index 27044cab8..000000000 --- a/docs/frontend_api/entities_fattribute.js.html +++ /dev/null @@ -1,136 +0,0 @@ - - - - - JSDoc: Source: entities/fattribute.js - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Source: entities/fattribute.js

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - 
                                                                                                                                                                                                                                                                                                                                                                                                                                  import promotedAttributeDefinitionParser from '../services/promoted_attribute_definition_parser.js';
-
-/**
- * There are currently only two types of attributes, labels or relations.
- * @typedef {"label" | "relation"} AttributeType
- */
-
-/**
- * Attribute is an abstract concept which has two real uses - label (key - value pair)
- * and relation (representing named relationship between source and target note)
- */
-class FAttribute {
-    constructor(froca, row) {
-        /** @type {Froca} */
-        this.froca = froca;
-
-        this.update(row);
-    }
-
-    update(row) {
-        /** @type {string} */
-        this.attributeId = row.attributeId;
-        /** @type {string} */
-        this.noteId = row.noteId;
-        /** @type {AttributeType} */
-        this.type = row.type;
-        /** @type {string} */
-        this.name = row.name;
-        /** @type {string} */
-        this.value = row.value;
-        /** @type {int} */
-        this.position = row.position;
-        /** @type {boolean} */
-        this.isInheritable = !!row.isInheritable;
-    }
-
-    /** @returns {FNote} */
-    getNote() {
-        return this.froca.notes[this.noteId];
-    }
-
-    /** @returns {Promise<FNote>} */
-    async getTargetNote() {
-        const targetNoteId = this.targetNoteId;
-
-        return await this.froca.getNote(targetNoteId, true);
-    }
-
-    get targetNoteId() { // alias
-        if (this.type !== 'relation') {
-            throw new Error(`Attribute ${this.attributeId} is not a relation`);
-        }
-
-        return this.value;
-    }
-
-    get isAutoLink() {
-        return this.type === 'relation' && ['internalLink', 'imageLink', 'relationMapLink', 'includeNoteLink'].includes(this.name);
-    }
-
-    get toString() {
-        return `FAttribute(attributeId=${this.attributeId}, type=${this.type}, name=${this.name}, value=${this.value})`;
-    }
-
-    isDefinition() {
-        return this.type === 'label' && (this.name.startsWith('label:') || this.name.startsWith('relation:'));
-    }
-
-    getDefinition() {
-        return promotedAttributeDefinitionParser.parse(this.value);
-    }
-
-    isDefinitionFor(attr) {
-        return this.type === 'label' && this.name === `${attr.type}:${attr.name}`;
-    }
-
-    get dto() {
-        const dto = Object.assign({}, this);
-        delete dto.froca;
-
-        return dto;
-    }
-}
-
-export default FAttribute;
-
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - diff --git a/docs/frontend_api/entities_fblob.js.html b/docs/frontend_api/entities_fblob.js.html deleted file mode 100644 index 4f647e402..000000000 --- a/docs/frontend_api/entities_fblob.js.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - - JSDoc: Source: entities/fblob.js - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Source: entities/fblob.js

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - 
                                                                                                                                                                                                                                                                                                                                                                                                                                  export default class FBlob {
-    constructor(row) {
-        /** @type {string} */
-        this.blobId = row.blobId;
-
-        /**
-         * can either contain the whole content (in e.g. string notes), only part (large text notes) or nothing at all (binary notes, images)
-         * @type {string}
-         */
-        this.content = row.content;
-        this.contentLength = row.contentLength;
-
-        /** @type {string} */
-        this.dateModified = row.dateModified;
-        /** @type {string} */
-        this.utcDateModified = row.utcDateModified;
-    }
-
-    /**
-     * @returns {*}
-     * @throws Error in case of invalid JSON */
-    getJsonContent() {
-        if (!this.content || !this.content.trim()) {
-            return null;
-        }
-
-        return JSON.parse(this.content);
-    }
-
-    /** @returns {*|null} valid object or null if the content cannot be parsed as JSON */
-    getJsonContentSafely() {
-        try {
-            return this.getJsonContent();
-        }
-        catch (e) {
-            return null;
-        }
-    }
-}
-
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - diff --git a/docs/frontend_api/entities_fbranch.js.html b/docs/frontend_api/entities_fbranch.js.html deleted file mode 100644 index f9252ef22..000000000 --- a/docs/frontend_api/entities_fbranch.js.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - JSDoc: Source: entities/fbranch.js - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Source: entities/fbranch.js

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - 
                                                                                                                                                                                                                                                                                                                                                                                                                                  /**
- * Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
- * parents.
- */
-class FBranch {
-    constructor(froca, row) {
-        /** @type {Froca} */
-        this.froca = froca;
-
-        this.update(row);
-    }
-
-    update(row) {
-        /**
-         * primary key
-         * @type {string}
-         */
-        this.branchId = row.branchId;
-        /** @type {string} */
-        this.noteId = row.noteId;
-        /** @type {string} */
-        this.parentNoteId = row.parentNoteId;
-        /** @type {int} */
-        this.notePosition = row.notePosition;
-        /** @type {string} */
-        this.prefix = row.prefix;
-        /** @type {boolean} */
-        this.isExpanded = !!row.isExpanded;
-        /** @type {boolean} */
-        this.fromSearchNote = !!row.fromSearchNote;
-    }
-
-    /** @returns {FNote} */
-    async getNote() {
-        return this.froca.getNote(this.noteId);
-    }
-
-    /** @returns {FNote} */
-    getNoteFromCache() {
-        return this.froca.getNoteFromCache(this.noteId);
-    }
-
-    /** @returns {FNote} */
-    async getParentNote() {
-        return this.froca.getNote(this.parentNoteId);
-    }
-
-    /** @returns {boolean} true if it's top level, meaning its parent is the root note */
-    isTopLevel() {
-        return this.parentNoteId === 'root';
-    }
-
-    get toString() {
-        return `FBranch(branchId=${this.branchId})`;
-    }
-
-    get pojo() {
-        const pojo = {...this};
-        delete pojo.froca;
-        return pojo;
-    }
-}
-
-export default FBranch;
-
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - diff --git a/docs/frontend_api/entities_fnote.js.html b/docs/frontend_api/entities_fnote.js.html deleted file mode 100644 index 9083cab69..000000000 --- a/docs/frontend_api/entities_fnote.js.html +++ /dev/null @@ -1,1064 +0,0 @@ - - - - - JSDoc: Source: entities/fnote.js - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Source: entities/fnote.js

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - 
                                                                                                                                                                                                                                                                                                                                                                                                                                  import server from '../services/server.js';
-import noteAttributeCache from "../services/note_attribute_cache.js";
-import ws from "../services/ws.js";
-import froca from "../services/froca.js";
-import protectedSessionHolder from "../services/protected_session_holder.js";
-import cssClassManager from "../services/css_class_manager.js";
-
-const LABEL = 'label';
-const RELATION = 'relation';
-
-const NOTE_TYPE_ICONS = {
-    "file": "bx bx-file",
-    "image": "bx bx-image",
-    "code": "bx bx-code",
-    "render": "bx bx-extension",
-    "search": "bx bx-file-find",
-    "relationMap": "bx bxs-network-chart",
-    "book": "bx bx-book",
-    "noteMap": "bx bxs-network-chart",
-    "mermaid": "bx bx-selection",
-    "canvas": "bx bx-pen",
-    "webView": "bx bx-globe-alt",
-    "launcher": "bx bx-link",
-    "doc": "bx bxs-file-doc",
-    "contentWidget": "bx bxs-widget",
-    "mindMap": "bx bx-sitemap"
-};
-
-/**
- * There are many different Note types, some of which are entirely opaque to the
- * end user. Those types should be used only for checking against, they are
- * not for direct use.
- * @typedef {"file" | "image" | "search" | "noteMap" | "launcher" | "doc" | "contentWidget" | "text" | "relationMap" | "render" | "canvas" | "mermaid" | "book" | "webView" | "code"} NoteType
- */
-
-/**
- * @typedef {Object} NotePathRecord
- * @property {boolean} isArchived
- * @property {boolean} isInHoistedSubTree
- * @property {boolean} isSearch
- * @property {Array<string>} notePath
- * @property {boolean} isHidden
- */
-
-/**
- * Note is the main node and concept in Trilium.
- */
-class FNote {
-    /**
-     * @param {Froca} froca
-     * @param {Object.<string, Object>} row
-     */
-    constructor(froca, row) {
-        /** @type {Froca} */
-        this.froca = froca;
-
-        /** @type {string[]} */
-        this.attributes = [];
-
-        /** @type {string[]} */
-        this.targetRelations = [];
-
-        /** @type {string[]} */
-        this.parents = [];
-        /** @type {string[]} */
-        this.children = [];
-
-        /** @type {Object.<string, string>} */
-        this.parentToBranch = {};
-
-        /** @type {Object.<string, string>} */
-        this.childToBranch = {};
-
-        /** @type {FAttachment[]|null} */
-        this.attachments = null; // lazy loaded
-
-        this.update(row);
-    }
-
-    update(row) {
-        /** @type {string} */
-        this.noteId = row.noteId;
-        /** @type {string} */
-        this.title = row.title;
-        /** @type {boolean} */
-        this.isProtected = !!row.isProtected;
-        /**
-         * See {@see NoteType} for info on values.
-         * @type {NoteType}
-         */
-        this.type = row.type;
-        /**
-         * content-type, e.g. "application/json"
-         * @type {string}
-         */
-        this.mime = row.mime;
-
-        // the main use case to keep this is to detect content change which should trigger refresh
-        this.blobId = row.blobId;
-    }
-
-    addParent(parentNoteId, branchId, sort = true) {
-        if (parentNoteId === 'none') {
-            return;
-        }
-
-        if (!this.parents.includes(parentNoteId)) {
-            this.parents.push(parentNoteId);
-        }
-
-        this.parentToBranch[parentNoteId] = branchId;
-
-        if (sort) {
-            this.sortParents();
-        }
-    }
-
-    addChild(childNoteId, branchId, sort = true) {
-        if (!(childNoteId in this.childToBranch)) {
-            this.children.push(childNoteId);
-        }
-
-        this.childToBranch[childNoteId] = branchId;
-
-        if (sort) {
-            this.sortChildren();
-        }
-    }
-
-    sortChildren() {
-        const branchIdPos = {};
-
-        for (const branchId of Object.values(this.childToBranch)) {
-            branchIdPos[branchId] = this.froca.getBranch(branchId).notePosition;
-        }
-
-        this.children.sort((a, b) => branchIdPos[this.childToBranch[a]] - branchIdPos[this.childToBranch[b]]);
-    }
-
-    /** @returns {boolean} */
-    isJson() {
-        return this.mime === "application/json";
-    }
-
-    async getContent() {
-        const blob = await this.getBlob();
-
-        return blob?.content;
-    }
-
-    async getJsonContent() {
-        const content = await this.getContent();
-
-        try {
-            return JSON.parse(content);
-        }
-        catch (e) {
-            console.log(`Cannot parse content of note '${this.noteId}': `, e.message);
-
-            return null;
-        }
-    }
-
-    /**
-     * @returns {string[]}
-     */
-    getParentBranchIds() {
-        return Object.values(this.parentToBranch);
-    }
-
-    /**
-     * @returns {string[]}
-     * @deprecated use getParentBranchIds() instead
-     */
-    getBranchIds() {
-        return this.getParentBranchIds();
-    }
-
-    /**
-     * @returns {FBranch[]}
-     */
-    getParentBranches() {
-        const branchIds = Object.values(this.parentToBranch);
-
-        return this.froca.getBranches(branchIds);
-    }
-
-    /**
-     * @returns {FBranch[]}
-     * @deprecated use getParentBranches() instead
-     */
-    getBranches() {
-        return this.getParentBranches();
-    }
-
-    /** @returns {boolean} */
-    hasChildren() {
-        return this.children.length > 0;
-    }
-
-    /** @returns {FBranch[]} */
-    getChildBranches() {
-        // don't use Object.values() to guarantee order
-        const branchIds = this.children.map(childNoteId => this.childToBranch[childNoteId]);
-
-        return this.froca.getBranches(branchIds);
-    }
-
-    /** @returns {string[]} */
-    getParentNoteIds() {
-        return this.parents;
-    }
-
-    /** @returns {FNote[]} */
-    getParentNotes() {
-        return this.froca.getNotesFromCache(this.parents);
-    }
-
-    // will sort the parents so that non-search & non-archived are first and archived at the end
-    // this is done so that non-search & non-archived paths are always explored as first when looking for a note path
-    sortParents() {
-        this.parents.sort((aNoteId, bNoteId) => {
-            const aBranchId = this.parentToBranch[aNoteId];
-
-            if (aBranchId && aBranchId.startsWith('virt-')) {
-                return 1;
-            }
-
-            const aNote = this.froca.getNoteFromCache(aNoteId);
-
-            if (aNote.isArchived || aNote.isHiddenCompletely()) {
-                return 1;
-            }
-
-            return aNoteId < bNoteId ? -1 : 1;
-        });
-    }
-
-    get isArchived() {
-        return this.hasAttribute('label', 'archived');
-    }
-
-    /** @returns {string[]} */
-    getChildNoteIds() {
-        return this.children;
-    }
-
-    /** @returns {Promise<FNote[]>} */
-    async getChildNotes() {
-        return await this.froca.getNotes(this.children);
-    }
-
-    /** @returns {Promise<FAttachment[]>} */
-    async getAttachments() {
-        if (!this.attachments) {
-            this.attachments = await this.froca.getAttachmentsForNote(this.noteId);
-        }
-
-        return this.attachments;
-    }
-
-    /** @returns {Promise<FAttachment[]>} */
-    async getAttachmentsByRole(role) {
-        return (await this.getAttachments())
-            .filter(attachment => attachment.role === role);
-    }
-
-    /** @returns {Promise<FAttachment>} */
-    async getAttachmentById(attachmentId) {
-        const attachments = await this.getAttachments();
-
-        return attachments.find(att => att.attachmentId === attachmentId);
-    }
-
-    isEligibleForConversionToAttachment() {
-        if (this.type !== 'image' || !this.isContentAvailable() || this.hasChildren() || this.getParentBranches().length !== 1) {
-            return false;
-        }
-
-        const targetRelations = this.getTargetRelations().filter(relation => relation.name === 'imageLink');
-
-        if (targetRelations.length > 1) {
-            return false;
-        }
-
-        const parentNote = this.getParentNotes()[0]; // at this point note can have only one parent
-        const referencingNote = targetRelations[0]?.getNote();
-
-        if (referencingNote && referencingNote !== parentNote) {
-            return false;
-        } else if (parentNote.type !== 'text' || !parentNote.isContentAvailable()) {
-            return false;
-        }
-
-        return true;
-    }
-
-    /**
-     * @param {string} [type] - (optional) attribute type to filter
-     * @param {string} [name] - (optional) attribute name to filter
-     * @returns {FAttribute[]} all note's attributes, including inherited ones
-     */
-    getOwnedAttributes(type, name) {
-        const attrs = this.attributes
-            .map(attributeId => this.froca.attributes[attributeId])
-            .filter(Boolean); // filter out nulls;
-
-        return this.__filterAttrs(attrs, type, name);
-    }
-
-    /**
-     * @param {string} [type] - (optional) attribute type to filter
-     * @param {string} [name] - (optional) attribute name to filter
-     * @returns {FAttribute[]} all note's attributes, including inherited ones
-     */
-    getAttributes(type, name) {
-        return this.__filterAttrs(this.__getCachedAttributes([]), type, name);
-    }
-
-    /**
-     * @param {string[]} path
-     * @return {FAttribute[]}
-     * @private
-     */
-    __getCachedAttributes(path) {
-        // notes/clones cannot form tree cycles, it is possible to create attribute inheritance cycle via templates
-        // when template instance is a parent of template itself
-        if (path.includes(this.noteId)) {
-            return [];
-        }
-
-        if (!(this.noteId in noteAttributeCache.attributes)) {
-            const newPath = [...path, this.noteId];
-            const attrArrs = [ this.getOwnedAttributes() ];
-
-            // inheritable attrs on root are typically not intended to be applied to hidden subtree #3537
-            if (this.noteId !== 'root' && this.noteId !== '_hidden') {
-                for (const parentNote of this.getParentNotes()) {
-                    // these virtual parent-child relationships are also loaded into froca
-                    if (parentNote.type !== 'search') {
-                        attrArrs.push(parentNote.__getInheritableAttributes(newPath));
-                    }
-                }
-            }
-
-            for (const templateAttr of attrArrs.flat().filter(attr => attr.type === 'relation' && ['template', 'inherit'].includes(attr.name))) {
-                const templateNote = this.froca.notes[templateAttr.value];
-
-                if (templateNote && templateNote.noteId !== this.noteId) {
-                    attrArrs.push(
-                        templateNote.__getCachedAttributes(newPath)
-                            // template attr is used as a marker for templates, but it's not meant to be inherited
-                            .filter(attr => !(attr.type === 'label' && (attr.name === 'template' || attr.name === 'workspacetemplate')))
-                    );
-                }
-            }
-
-            noteAttributeCache.attributes[this.noteId] = [];
-            const addedAttributeIds = new Set();
-
-            for (const attr of attrArrs.flat()) {
-                if (!addedAttributeIds.has(attr.attributeId)) {
-                    addedAttributeIds.add(attr.attributeId);
-
-                    noteAttributeCache.attributes[this.noteId].push(attr);
-                }
-            }
-        }
-
-        return noteAttributeCache.attributes[this.noteId];
-    }
-
-    isRoot() {
-        return this.noteId === 'root';
-    }
-
-    /**
-     * 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)
-     */
-    getAllNotePaths() {
-        if (this.noteId === 'root') {
-            return [['root']];
-        }
-
-        const parentNotes = this.getParentNotes().filter(note => note.type !== 'search');
-
-        const notePaths = parentNotes.length === 1
-            ? parentNotes[0].getAllNotePaths() // optimization for the most common case
-            : parentNotes.flatMap(parentNote => parentNote.getAllNotePaths());
-
-        for (const notePath of notePaths) {
-            notePath.push(this.noteId);
-        }
-
-        return notePaths;
-    }
-
-    /**
-     * @param {string} [hoistedNoteId='root']
-     * @return {Array<NotePathRecord>}
-     */
-    getSortedNotePathRecords(hoistedNoteId = 'root') {
-        const isHoistedRoot = hoistedNoteId === 'root';
-
-        const notePaths = this.getAllNotePaths().map(path => ({
-            notePath: path,
-            isInHoistedSubTree: isHoistedRoot || path.includes(hoistedNoteId),
-            isArchived: path.some(noteId => froca.notes[noteId].isArchived),
-            isSearch: path.find(noteId => froca.notes[noteId].type === 'search'),
-            isHidden: path.includes('_hidden')
-        }));
-
-        notePaths.sort((a, b) => {
-            if (a.isInHoistedSubTree !== b.isInHoistedSubTree) {
-                return a.isInHoistedSubTree ? -1 : 1;
-            } else if (a.isArchived !== b.isArchived) {
-                return a.isArchived ? 1 : -1;
-            } else if (a.isHidden !== b.isHidden) {
-                return a.isHidden ? 1 : -1;
-            } else if (a.isSearch !== b.isSearch) {
-                return a.isSearch ? 1 : -1;
-            } else {
-                return a.notePath.length - b.notePath.length;
-            }
-        });
-
-        return notePaths;
-    }
-
-    /**
-     * Returns the note path considered to be the "best"
-     *
-     * @param {string} [hoistedNoteId='root']
-     * @return {string[]} array of noteIds constituting the particular note path
-     */
-    getBestNotePath(hoistedNoteId = 'root') {
-        return this.getSortedNotePathRecords(hoistedNoteId)[0]?.notePath;
-    }
-
-    /**
-     * Returns the note path considered to be the "best"
-     *
-     * @param {string} [hoistedNoteId='root']
-     * @return {string} serialized note path (e.g. 'root/a1h315/js725h')
-     */
-    getBestNotePathString(hoistedNoteId = 'root') {
-        const notePath = this.getBestNotePath(hoistedNoteId);
-
-        return notePath?.join("/");
-    }
-
-    /**
-     * @return boolean - true if there's no non-hidden path, note is not cloned to the visible tree
-     */
-    isHiddenCompletely() {
-        if (this.noteId === '_hidden') {
-            return true;
-        } else if (this.noteId === 'root') {
-            return false;
-        }
-
-        for (const parentNote of this.getParentNotes()) {
-            if (parentNote.noteId === 'root') {
-                return false;
-            } else if (parentNote.noteId === '_hidden' || parentNote.type === 'search') {
-                continue;
-            }
-
-            if (!parentNote.isHiddenCompletely()) {
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-    /**
-     * @param {FAttribute[]} attributes
-     * @param {AttributeType} type
-     * @param {string} name
-     * @return {FAttribute[]}
-     * @private
-     */
-    __filterAttrs(attributes, type, name) {
-        this.__validateTypeName(type, name);
-
-        if (!type && !name) {
-            return attributes;
-        } else if (type && name) {
-            return attributes.filter(attr => attr.name === name && attr.type === type);
-        } else if (type) {
-            return attributes.filter(attr => attr.type === type);
-        } else if (name) {
-            return attributes.filter(attr => attr.name === name);
-        }
-    }
-
-    __getInheritableAttributes(path) {
-        const attrs = this.__getCachedAttributes(path);
-
-        return attrs.filter(attr => attr.isInheritable);
-    }
-
-    __validateTypeName(type, name) {
-        if (type && type !== 'label' && type !== 'relation') {
-            throw new Error(`Unrecognized attribute type '${type}'. Only 'label' and 'relation' are possible values.`);
-        }
-
-        if (name) {
-            const firstLetter = name.charAt(0);
-            if (firstLetter === '#' || firstLetter === '~') {
-                throw new Error(`Detect '#' or '~' in the attribute's name. In the API, attribute names should be set without these characters.`);
-            }
-        }
-    }
-
-    /**
-     * @param {string} [name] - label name to filter
-     * @returns {FAttribute[]} all note's labels (attributes with type label), including inherited ones
-     */
-    getOwnedLabels(name) {
-        return this.getOwnedAttributes(LABEL, name);
-    }
-
-    /**
-     * @param {string} [name] - label name to filter
-     * @returns {FAttribute[]} all note's labels (attributes with type label), including inherited ones
-     */
-    getLabels(name) {
-        return this.getAttributes(LABEL, name);
-    }
-
-    getIcon() {
-        const iconClassLabels = this.getLabels('iconClass');
-        const workspaceIconClass = this.getWorkspaceIconClass();
-
-        if (iconClassLabels.length > 0) {
-            return iconClassLabels[0].value;
-        }
-        else if (workspaceIconClass) {
-            return workspaceIconClass;
-        }
-        else if (this.noteId === 'root') {
-            return "bx bx-home-alt-2";
-        }
-        if (this.noteId === '_share') {
-            return "bx bx-share-alt";
-        }
-        else if (this.type === 'text') {
-            if (this.isFolder()) {
-                return "bx bx-folder";
-            }
-            else {
-                return "bx bx-note";
-            }
-        }
-        else if (this.type === 'code' && this.mime.startsWith('text/x-sql')) {
-            return "bx bx-data";
-        }
-        else {
-            return NOTE_TYPE_ICONS[this.type];
-        }
-    }
-
-    getColorClass() {
-        const color = this.getLabelValue("color");
-        return cssClassManager.createClassForColor(color);
-    }
-
-    isFolder() {
-        return this.type === 'search'
-            || this.getFilteredChildBranches().length > 0;
-    }
-
-    getFilteredChildBranches() {
-        let childBranches = this.getChildBranches();
-
-        if (!childBranches) {
-            ws.logError(`No children for '${this.noteId}'. This shouldn't happen.`);
-            return;
-        }
-
-        // we're not checking hideArchivedNotes since that would mean we need to lazy load the child notes
-        // which would seriously slow down everything.
-        // we check this flag only once user chooses to expand the parent. This has the negative consequence that
-        // note may appear as a folder but not contain any children when all of them are archived
-
-        return childBranches;
-    }
-
-    /**
-     * @param {string} [name] - relation name to filter
-     * @returns {FAttribute[]} all note's relations (attributes with type relation), including inherited ones
-     */
-    getOwnedRelations(name) {
-        return this.getOwnedAttributes(RELATION, name);
-    }
-
-    /**
-     * @param {string} [name] - relation name to filter
-     * @returns {FAttribute[]} all note's relations (attributes with type relation), including inherited ones
-     */
-    getRelations(name) {
-        return this.getAttributes(RELATION, name);
-    }
-
-    /**
-     * @param {AttributeType} type - attribute type (label, relation, etc.)
-     * @param {string} name - attribute name
-     * @returns {boolean} true if note has an attribute with given type and name (including inherited)
-     */
-    hasAttribute(type, name) {
-        const attributes = this.getAttributes();
-
-        return attributes.some(attr => attr.name === name && attr.type === type);
-    }
-
-    /**
-     * @param {AttributeType} type - attribute type (label, relation, etc.)
-     * @param {string} name - attribute name
-     * @returns {boolean} true if note has an attribute with given type and name (including inherited)
-     */
-    hasOwnedAttribute(type, name) {
-        return !!this.getOwnedAttribute(type, name);
-    }
-
-    /**
-     * @param {AttributeType} type - attribute type (label, relation, etc.)
-     * @param {string} name - attribute name
-     * @returns {FAttribute} 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.
-     */
-    getOwnedAttribute(type, name) {
-        const attributes = this.getOwnedAttributes();
-
-        return attributes.find(attr => attr.name === name && attr.type === type);
-    }
-
-    /**
-     * @param {AttributeType} type - attribute type (label, relation, etc.)
-     * @param {string} name - attribute name
-     * @returns {FAttribute} 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.
-     */
-    getAttribute(type, name) {
-        const attributes = this.getAttributes();
-
-        return attributes.find(attr => attr.name === name && attr.type === type);
-    }
-
-    /**
-     * @param {AttributeType} type - attribute type (label, relation, etc.)
-     * @param {string} name - attribute name
-     * @returns {string} attribute value of the given type and name or null if no such attribute exists.
-     */
-    getOwnedAttributeValue(type, name) {
-        const attr = this.getOwnedAttribute(type, name);
-
-        return attr ? attr.value : null;
-    }
-
-    /**
-     * @param {AttributeType} type - attribute type (label, relation, etc.)
-     * @param {string} name - attribute name
-     * @returns {string} attribute value of the given type and name or null if no such attribute exists.
-     */
-    getAttributeValue(type, name) {
-        const attr = this.getAttribute(type, name);
-
-        return attr ? attr.value : null;
-    }
-
-    /**
-     * @param {string} name - label name
-     * @returns {boolean} true if label exists (excluding inherited)
-     */
-    hasOwnedLabel(name) { return this.hasOwnedAttribute(LABEL, name); }
-
-    /**
-     * @param {string} name - label name
-     * @returns {boolean} true if label exists (including inherited)
-     */
-    hasLabel(name) { return this.hasAttribute(LABEL, name); }
-
-    /**
-     * @param {string} name - label name
-     * @returns {boolean} true if label exists (including inherited) and does not have "false" value.
-     */
-    isLabelTruthy(name) {
-        const label = this.getLabel(name);
-
-        if (!label) {
-            return false;
-        }
-
-        return label && label.value !== 'false';
-    }
-
-    /**
-     * @param {string} name - relation name
-     * @returns {boolean} true if relation exists (excluding inherited)
-     */
-    hasOwnedRelation(name) { return this.hasOwnedAttribute(RELATION, name); }
-
-    /**
-     * @param {string} name - relation name
-     * @returns {boolean} true if relation exists (including inherited)
-     */
-    hasRelation(name) { return this.hasAttribute(RELATION, name); }
-
-    /**
-     * @param {string} name - label name
-     * @returns {FAttribute} label if it exists, null otherwise
-     */
-    getOwnedLabel(name) { return this.getOwnedAttribute(LABEL, name); }
-
-    /**
-     * @param {string} name - label name
-     * @returns {FAttribute} label if it exists, null otherwise
-     */
-    getLabel(name) { return this.getAttribute(LABEL, name); }
-
-    /**
-     * @param {string} name - relation name
-     * @returns {FAttribute} relation if it exists, null otherwise
-     */
-    getOwnedRelation(name) { return this.getOwnedAttribute(RELATION, name); }
-
-    /**
-     * @param {string} name - relation name
-     * @returns {FAttribute} relation if it exists, null otherwise
-     */
-    getRelation(name) { return this.getAttribute(RELATION, name); }
-
-    /**
-     * @param {string} name - label name
-     * @returns {string} label value if label exists, null otherwise
-     */
-    getOwnedLabelValue(name) { return this.getOwnedAttributeValue(LABEL, name); }
-
-    /**
-     * @param {string} name - label name
-     * @returns {string} label value if label exists, null otherwise
-     */
-    getLabelValue(name) { return this.getAttributeValue(LABEL, name); }
-
-    /**
-     * @param {string} name - relation name
-     * @returns {string} relation value if relation exists, null otherwise
-     */
-    getOwnedRelationValue(name) { return this.getOwnedAttributeValue(RELATION, name); }
-
-    /**
-     * @param {string} name - relation name
-     * @returns {string} relation value if relation exists, null otherwise
-     */
-    getRelationValue(name) { return this.getAttributeValue(RELATION, name); }
-
-    /**
-     * @param {string} name
-     * @returns {Promise<FNote>|null} target note of the relation or null (if target is empty or note was not found)
-     */
-    async getRelationTarget(name) {
-        const targets = await this.getRelationTargets(name);
-
-        return targets.length > 0 ? targets[0] : null;
-    }
-
-    /**
-     * @param {string} [name] - relation name to filter
-     * @returns {Promise<FNote[]>}
-     */
-    async getRelationTargets(name) {
-        const relations = this.getRelations(name);
-        const targets = [];
-
-        for (const relation of relations) {
-            targets.push(await this.froca.getNote(relation.value));
-        }
-
-        return targets;
-    }
-
-    /**
-     * @returns {FNote[]}
-     */
-    getNotesToInheritAttributesFrom() {
-        const relations = [
-            ...this.getRelations('template'),
-            ...this.getRelations('inherit')
-        ];
-
-        return relations.map(rel => this.froca.notes[rel.value]);
-    }
-
-    getPromotedDefinitionAttributes() {
-        if (this.isLabelTruthy('hidePromotedAttributes')) {
-            return [];
-        }
-
-        const promotedAttrs = this.getAttributes()
-            .filter(attr => attr.isDefinition())
-            .filter(attr => {
-                const def = attr.getDefinition();
-
-                return def && def.isPromoted;
-            });
-
-        // attrs are not resorted if position changes after the initial load
-        promotedAttrs.sort((a, b) => {
-            if (a.noteId === b.noteId) {
-                return a.position < b.position ? -1 : 1;
-            } else {
-                // inherited promoted attributes should stay grouped: https://github.com/zadam/trilium/issues/3761
-                return a.noteId < b.noteId ? -1 : 1;
-            }
-        });
-
-        return promotedAttrs;
-    }
-
-    hasAncestor(ancestorNoteId, followTemplates = false, visitedNoteIds = null) {
-        if (this.noteId === ancestorNoteId) {
-            return true;
-        }
-
-        if (!visitedNoteIds) {
-            visitedNoteIds = new Set();
-        } else if (visitedNoteIds.has(this.noteId)) {
-            // to avoid infinite cycle when template is descendent of the instance
-            return false;
-        }
-
-        visitedNoteIds.add(this.noteId);
-
-        if (followTemplates) {
-            for (const templateNote of this.getNotesToInheritAttributesFrom()) {
-                if (templateNote.hasAncestor(ancestorNoteId, followTemplates, visitedNoteIds)) {
-                    return true;
-                }
-            }
-        }
-
-        for (const parentNote of this.getParentNotes()) {
-            if (parentNote.hasAncestor(ancestorNoteId, followTemplates, visitedNoteIds)) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    isInHiddenSubtree() {
-        return this.noteId === '_hidden' || this.hasAncestor('_hidden');
-    }
-
-    /**
-     * @deprecated NOOP
-     */
-    invalidateAttributeCache() {}
-
-    /**
-     * Get relations which target this note
-     *
-     * @returns {FAttribute[]}
-     */
-    getTargetRelations() {
-        return this.targetRelations
-            .map(attributeId => this.froca.attributes[attributeId]);
-    }
-
-    /**
-     * Get relations which target this note
-     *
-     * @returns {Promise<FNote[]>}
-     */
-    async getTargetRelationSourceNotes() {
-        const targetRelations = this.getTargetRelations();
-
-        return await this.froca.getNotes(targetRelations.map(tr => tr.noteId));
-    }
-
-    /**
-     * @deprecated use getBlob() instead
-     * @return {Promise<FBlob>}
-     */
-    async getNoteComplement() {
-        return this.getBlob();
-    }
-
-    /** @return {Promise<FBlob>} */
-    async getBlob() {
-        return await this.froca.getBlob('notes', this.noteId);
-    }
-
-    toString() {
-        return `Note(noteId=${this.noteId}, title=${this.title})`;
-    }
-
-    get dto() {
-        const dto = Object.assign({}, this);
-        delete dto.froca;
-
-        return dto;
-    }
-
-    getCssClass() {
-        const labels = this.getLabels('cssClass');
-        return labels.map(l => l.value).join(' ');
-    }
-
-    getWorkspaceIconClass() {
-        const labels = this.getLabels('workspaceIconClass');
-        return labels.length > 0 ? labels[0].value : "";
-    }
-
-    getWorkspaceTabBackgroundColor() {
-        const labels = this.getLabels('workspaceTabBackgroundColor');
-        return labels.length > 0 ? labels[0].value : "";
-    }
-
-    /** @returns {boolean} true if this note is JavaScript (code or file) */
-    isJavaScript() {
-        return (this.type === "code" || this.type === "file" || this.type === 'launcher')
-            && (this.mime.startsWith("application/javascript")
-                || this.mime === "application/x-javascript"
-                || this.mime === "text/javascript");
-    }
-
-    /** @returns {boolean} true if this note is HTML */
-    isHtml() {
-        return (this.type === "code" || this.type === "file" || this.type === "render") && this.mime === "text/html";
-    }
-
-    /** @returns {string|null} JS script environment - either "frontend" or "backend" */
-    getScriptEnv() {
-        if (this.isHtml() || (this.isJavaScript() && this.mime.endsWith('env=frontend'))) {
-            return "frontend";
-        }
-
-        if (this.type === 'render') {
-            return "frontend";
-        }
-
-        if (this.isJavaScript() && this.mime.endsWith('env=backend')) {
-            return "backend";
-        }
-
-        return null;
-    }
-
-    async executeScript() {
-        if (!this.isJavaScript()) {
-            throw new Error(`Note ${this.noteId} is of type ${this.type} and mime ${this.mime} and thus cannot be executed`);
-        }
-
-        const env = this.getScriptEnv();
-
-        if (env === "frontend") {
-            const bundleService = (await import("../services/bundle.js")).default;
-            return await bundleService.getAndExecuteBundle(this.noteId);
-        }
-        else if (env === "backend") {
-            const resp = await server.post(`script/run/${this.noteId}`);
-        }
-        else {
-            throw new Error(`Unrecognized env type ${env} for note ${this.noteId}`);
-        }
-    }
-
-    isShared() {
-        for (const parentNoteId of this.parents) {
-            if (parentNoteId === 'root' || parentNoteId === 'none') {
-                continue;
-            }
-
-            const parentNote = froca.notes[parentNoteId];
-
-            if (!parentNote || parentNote.type === 'search') {
-                continue;
-            }
-
-            if (parentNote.noteId === '_share' || parentNote.isShared()) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    isContentAvailable() {
-        return !this.isProtected || protectedSessionHolder.isProtectedSessionAvailable()
-    }
-
-    isLaunchBarConfig() {
-        return this.type === 'launcher' || ['_lbRoot', '_lbAvailableLaunchers', '_lbVisibleLaunchers'].includes(this.noteId);
-    }
-
-    isOptions() {
-        return this.noteId.startsWith("_options");
-    }
-
-    /**
-     * Provides note's date metadata.
-     *
-     * @returns {Promise<{dateCreated: string, utcDateCreated: string, dateModified: string, utcDateModified: string}>}
-     */
-    async getMetadata() {
-        return await server.get(`notes/${this.noteId}/metadata`);
-    }
-}
-
-export default FNote;
-
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - diff --git a/docs/frontend_api/fonts/OpenSans-Bold-webfont.eot b/docs/frontend_api/fonts/OpenSans-Bold-webfont.eot deleted file mode 100644 index 5d20d9163..000000000 Binary files a/docs/frontend_api/fonts/OpenSans-Bold-webfont.eot and /dev/null differ diff --git a/docs/frontend_api/fonts/OpenSans-Bold-webfont.svg b/docs/frontend_api/fonts/OpenSans-Bold-webfont.svg deleted file mode 100644 index 3ed7be4bc..000000000 --- a/docs/frontend_api/fonts/OpenSans-Bold-webfont.svg +++ /dev/null @@ -1,1830 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/fonts/OpenSans-Bold-webfont.woff b/docs/frontend_api/fonts/OpenSans-Bold-webfont.woff deleted file mode 100644 index 1205787b0..000000000 Binary files a/docs/frontend_api/fonts/OpenSans-Bold-webfont.woff and /dev/null differ diff --git a/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.eot b/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.eot deleted file mode 100644 index 1f639a15f..000000000 Binary files a/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.eot and /dev/null differ diff --git a/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.svg b/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.svg deleted file mode 100644 index 6a2607b9d..000000000 --- a/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.svg +++ /dev/null @@ -1,1830 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.woff b/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.woff deleted file mode 100644 index ed760c062..000000000 Binary files a/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.woff and /dev/null differ diff --git a/docs/frontend_api/fonts/OpenSans-Italic-webfont.eot b/docs/frontend_api/fonts/OpenSans-Italic-webfont.eot deleted file mode 100644 index 0c8a0ae06..000000000 Binary files a/docs/frontend_api/fonts/OpenSans-Italic-webfont.eot and /dev/null differ diff --git a/docs/frontend_api/fonts/OpenSans-Italic-webfont.svg b/docs/frontend_api/fonts/OpenSans-Italic-webfont.svg deleted file mode 100644 index e1075dcc2..000000000 --- a/docs/frontend_api/fonts/OpenSans-Italic-webfont.svg +++ /dev/null @@ -1,1830 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/fonts/OpenSans-Italic-webfont.woff b/docs/frontend_api/fonts/OpenSans-Italic-webfont.woff deleted file mode 100644 index ff652e643..000000000 Binary files a/docs/frontend_api/fonts/OpenSans-Italic-webfont.woff and /dev/null differ diff --git a/docs/frontend_api/fonts/OpenSans-Light-webfont.eot b/docs/frontend_api/fonts/OpenSans-Light-webfont.eot deleted file mode 100644 index 14868406a..000000000 Binary files a/docs/frontend_api/fonts/OpenSans-Light-webfont.eot and /dev/null differ diff --git a/docs/frontend_api/fonts/OpenSans-Light-webfont.svg b/docs/frontend_api/fonts/OpenSans-Light-webfont.svg deleted file mode 100644 index 11a472ca8..000000000 --- a/docs/frontend_api/fonts/OpenSans-Light-webfont.svg +++ /dev/null @@ -1,1831 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/fonts/OpenSans-Light-webfont.woff b/docs/frontend_api/fonts/OpenSans-Light-webfont.woff deleted file mode 100644 index e78607481..000000000 Binary files a/docs/frontend_api/fonts/OpenSans-Light-webfont.woff and /dev/null differ diff --git a/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.eot b/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.eot deleted file mode 100644 index 8f445929f..000000000 Binary files a/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.eot and /dev/null differ diff --git a/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.svg b/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.svg deleted file mode 100644 index 431d7e354..000000000 --- a/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.svg +++ /dev/null @@ -1,1835 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.woff b/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.woff deleted file mode 100644 index 43e8b9e6c..000000000 Binary files a/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.woff and /dev/null differ diff --git a/docs/frontend_api/fonts/OpenSans-Regular-webfont.eot b/docs/frontend_api/fonts/OpenSans-Regular-webfont.eot deleted file mode 100644 index 6bbc3cf58..000000000 Binary files a/docs/frontend_api/fonts/OpenSans-Regular-webfont.eot and /dev/null differ diff --git a/docs/frontend_api/fonts/OpenSans-Regular-webfont.svg b/docs/frontend_api/fonts/OpenSans-Regular-webfont.svg deleted file mode 100644 index 25a395234..000000000 --- a/docs/frontend_api/fonts/OpenSans-Regular-webfont.svg +++ /dev/null @@ -1,1831 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/fonts/OpenSans-Regular-webfont.woff b/docs/frontend_api/fonts/OpenSans-Regular-webfont.woff deleted file mode 100644 index e231183dc..000000000 Binary files a/docs/frontend_api/fonts/OpenSans-Regular-webfont.woff and /dev/null differ diff --git a/docs/frontend_api/global.html b/docs/frontend_api/global.html deleted file mode 100644 index ef95e02f7..000000000 --- a/docs/frontend_api/global.html +++ /dev/null @@ -1,907 +0,0 @@ - - - - - JSDoc: Global - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Global

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Members

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  api :FrontendScriptApi

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - An instance of the frontend api available globally. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getJsonContent() → {*}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Throws:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - Error in case of invalid JSON - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -* - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  getJsonContentSafely() → {*|null}

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - valid object or null if the content cannot be parsed as JSON -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Type -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -* -| - -null - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Definitions

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  AttributeType

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - There are currently only two types of attributes, labels or relations. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -"label" -| - -"relation" - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  NotePathRecord

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -Object - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  isArchived - - -boolean - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  isInHoistedSubTree - - -boolean - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  isSearch - - -boolean - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  notePath - - -Array.<string> - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  isHidden - - -boolean - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  NoteType

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - There are many different Note types, some of which are entirely opaque to the -end user. Those types should be used only for checking against, they are -not for direct use. -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -"file" -| - -"image" -| - -"search" -| - -"noteMap" -| - -"launcher" -| - -"doc" -| - -"contentWidget" -| - -"text" -| - -"relationMap" -| - -"render" -| - -"canvas" -| - -"mermaid" -| - -"book" -| - -"webView" -| - -"code" - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  int

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - A whole number -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Type:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -number - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Source:
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/index.html b/docs/frontend_api/index.html deleted file mode 100644 index 9d16d032a..000000000 --- a/docs/frontend_api/index.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - - JSDoc: Home - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Home

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - \ No newline at end of file diff --git a/docs/frontend_api/scripts/linenumber.js b/docs/frontend_api/scripts/linenumber.js deleted file mode 100644 index 4354785ce..000000000 --- a/docs/frontend_api/scripts/linenumber.js +++ /dev/null @@ -1,25 +0,0 @@ -/*global document */ -(() => { - const source = document.getElementsByClassName('prettyprint source linenums'); - let i = 0; - let lineNumber = 0; - let lineId; - let lines; - let totalLines; - let anchorHash; - - if (source && source[0]) { - anchorHash = document.location.hash.substring(1); - lines = source[0].getElementsByTagName('li'); - totalLines = lines.length; - - for (; i < totalLines; i++) { - lineNumber++; - lineId = `line${lineNumber}`; - lines[i].id = lineId; - if (lineId === anchorHash) { - lines[i].className += ' selected'; - } - } - } -})(); diff --git a/docs/frontend_api/scripts/prettify/Apache-License-2.0.txt b/docs/frontend_api/scripts/prettify/Apache-License-2.0.txt deleted file mode 100644 index d64569567..000000000 --- a/docs/frontend_api/scripts/prettify/Apache-License-2.0.txt +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/docs/frontend_api/scripts/prettify/lang-css.js b/docs/frontend_api/scripts/prettify/lang-css.js deleted file mode 100644 index 041e1f590..000000000 --- a/docs/frontend_api/scripts/prettify/lang-css.js +++ /dev/null @@ -1,2 +0,0 @@ -PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com", -/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]); diff --git a/docs/frontend_api/scripts/prettify/prettify.js b/docs/frontend_api/scripts/prettify/prettify.js deleted file mode 100644 index eef5ad7e6..000000000 --- a/docs/frontend_api/scripts/prettify/prettify.js +++ /dev/null @@ -1,28 +0,0 @@ -var q=null;window.PR_SHOULD_USE_CONTINUATION=!0; -(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a= -[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m), -l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/, -q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/, -q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g, -"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a), -a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e} -for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"], -"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"], -H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"], -J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+ -I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]), -["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css", -/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}), -["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes", -hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b= -!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p - - - - JSDoc: Source: services/frontend_script_api.js - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Source: services/frontend_script_api.js

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - 
                                                                                                                                                                                                                                                                                                                                                                                                                                  import server from './server.js';
-import utils from './utils.js';
-import toastService from './toast.js';
-import linkService from './link.js';
-import froca from './froca.js';
-import noteTooltipService from './note_tooltip.js';
-import protectedSessionService from './protected_session.js';
-import dateNotesService from './date_notes.js';
-import searchService from './search.js';
-import RightPanelWidget from '../widgets/right_panel_widget.js';
-import ws from "./ws.js";
-import appContext from "../components/app_context.js";
-import NoteContextAwareWidget from "../widgets/note_context_aware_widget.js";
-import BasicWidget from "../widgets/basic_widget.js";
-import SpacedUpdate from "./spaced_update.js";
-import shortcutService from "./shortcuts.js";
-import dialogService from "./dialog.js";
-
-
-/**
- * A whole number
- * @typedef {number} int
- */
-
-/**
- * An instance of the frontend api available globally.
- * @global
- * @var {FrontendScriptApi} api
- */
-
-/**
- * <p>This is the main frontend API interface for scripts. All the properties and methods are published in the "api" object
- * available in the JS frontend notes. You can use e.g. <code>api.showMessage(api.startNote.title);</code></p>
- *
- * @constructor
- */
-function FrontendScriptApi(startNote, currentNote, originEntity = null, $container = null) {
-    /**
-     * Container of all the rendered script content
-     * @type {jQuery}
-     * */
-    this.$container = $container;
-
-    /**
-     * Note where the script started executing, i.e., the (event) entrypoint of the current script execution.
-     * @type {FNote}
-     */
-    this.startNote = startNote;
-
-    /**
-     * Note where the script is currently executing, i.e. the note where the currently executing source code is written.
-     * @type {FNote}
-     */
-    this.currentNote = currentNote;
-
-    /**
-     * Entity whose event triggered this execution.
-     * @type {object|null}
-     */
-    this.originEntity = originEntity;
-
-    /**
-     * day.js library for date manipulation.
-     * See {@link https://day.js.org} for documentation
-     * @see https://day.js.org
-     * @type {dayjs}
-     */
-    this.dayjs = dayjs;
-
-    /** @type {RightPanelWidget} */
-    this.RightPanelWidget = RightPanelWidget;
-
-    /** @type {NoteContextAwareWidget} */
-    this.NoteContextAwareWidget = NoteContextAwareWidget;
-
-    /** @type {BasicWidget} */
-    this.BasicWidget = BasicWidget;
-
-    /**
-     * Activates note in the tree and in the note detail.
-     *
-     * @method
-     * @param {string} notePath (or noteId)
-     * @returns {Promise<void>}
-     */
-    this.activateNote = async notePath => {
-        await appContext.tabManager.getActiveContext().setNote(notePath);
-    };
-
-    /**
-     * Activates newly created note. Compared to this.activateNote() also makes sure that frontend has been fully synced.
-     *
-     * @param {string} notePath (or noteId)
-     * @returns {Promise<void>}
-     */
-    this.activateNewNote = async notePath => {
-        await ws.waitForMaxKnownEntityChangeId();
-
-        await appContext.tabManager.getActiveContext().setNote(notePath);
-        await appContext.triggerEvent('focusAndSelectTitle');
-    };
-
-    /**
-     * Open a note in a new tab.
-     *
-     * @method
-     * @param {string} notePath (or noteId)
-     * @param {boolean} activate - set to true to activate the new tab, false to stay on the current tab
-     * @returns {Promise<void>}
-     */
-    this.openTabWithNote = async (notePath, activate) => {
-        await ws.waitForMaxKnownEntityChangeId();
-
-        await appContext.tabManager.openTabWithNoteWithHoisting(notePath, { activate });
-
-        if (activate) {
-            await appContext.triggerEvent('focusAndSelectTitle');
-        }
-    };
-
-    /**
-     * Open a note in a new split.
-     *
-     * @method
-     * @param {string} notePath (or noteId)
-     * @param {boolean} activate - set to true to activate the new split, false to stay on the current split
-     * @returns {Promise<void>}
-     */
-    this.openSplitWithNote = async (notePath, activate) => {
-        await ws.waitForMaxKnownEntityChangeId();
-
-        const subContexts = appContext.tabManager.getActiveContext().getSubContexts();
-        const {ntxId} = subContexts[subContexts.length - 1];
-
-        await appContext.triggerCommand("openNewNoteSplit", {ntxId, notePath});
-
-        if (activate) {
-            await appContext.triggerEvent('focusAndSelectTitle');
-        }
-    };
-
-    /**
-     * Adds a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.
-     *
-     * @method
-     * @deprecated you can now create/modify launchers in the top-left Menu -> Configure Launchbar
-     *             for special needs there's also backend API's createOrUpdateLauncher()
-     * @param {object} opts
-     * @param {string} opts.title
-     * @param {function} opts.action - callback handling the click on the button
-     * @param {string} [opts.id] - id of the button, used to identify the old instances of this button to be replaced
-     *                          ID is optional because of BC, but not specifying it is deprecated. ID can be alphanumeric only.
-     * @param {string} [opts.icon] - name of the boxicon to be used (e.g. "time" for "bx-time" icon)
-     * @param {string} [opts.shortcut] - keyboard shortcut for the button, e.g. "alt+t"
-     */
-    this.addButtonToToolbar = async opts => {
-        console.warn("api.addButtonToToolbar() has been deprecated since v0.58 and may be removed in the future. Use  Menu -> Configure Launchbar to create/update launchers instead.");
-
-        const {action, ...reqBody} = opts;
-        reqBody.action = action.toString();
-
-        await server.put('special-notes/api-script-launcher', reqBody);
-    };
-
-    function prepareParams(params) {
-        if (!params) {
-            return params;
-        }
-
-        return params.map(p => {
-            if (typeof p === "function") {
-                return `!@#Function: ${p.toString()}`;
-            }
-            else {
-                return p;
-            }
-        });
-    }
-
-    /**
-     * @private
-     */
-    this.__runOnBackendInner = async (func, params, transactional) => {
-        if (typeof func === "function") {
-            func = func.toString();
-        }
-
-        const ret = await server.post('script/exec', {
-            script: func,
-            params: prepareParams(params),
-            startNoteId: startNote.noteId,
-            currentNoteId: currentNote.noteId,
-            originEntityName: "notes", // currently there's no other entity on the frontend which can trigger event
-            originEntityId: originEntity ? originEntity.noteId : null,
-            transactional
-        }, "script");
-
-        if (ret.success) {
-            await ws.waitForMaxKnownEntityChangeId();
-
-            return ret.executionResult;
-        } else {
-            throw new Error(`server error: ${ret.error}`);
-        }
-    }
-
-    /**
-     * Executes given anonymous function on the backend.
-     * Internally this serializes the anonymous function into string and sends it to backend via AJAX.
-     * Please make sure that the supplied function is synchronous. Only sync functions will work correctly
-     * with transaction management. If you really know what you're doing, you can call api.runAsyncOnBackendWithManualTransactionHandling()
-     *
-     * @method
-     * @param {function|string} func - (synchronous) function to be executed on the backend
-     * @param {Array.<?>} params - list of parameters to the anonymous function to be sent to backend
-     * @returns {Promise<*>} return value of the executed function on the backend
-     */
-    this.runOnBackend = async (func, params = []) => {
-        if (func?.constructor.name === "AsyncFunction" || func?.startsWith?.("async ")) {
-            toastService.showError(t("frontend_script_api.async_warning"));
-        }
-
-        return await this.__runOnBackendInner(func, params, true);
-    };
-
-    /**
-     * Executes given anonymous function on the backend.
-     * Internally this serializes the anonymous function into string and sends it to backend via AJAX.
-     * This function is meant for advanced needs where an async function is necessary.
-     * In this case, the automatic request-scoped transaction management is not applied,
-     * and you need to manually define transaction via api.transactional().
-     *
-     * If you have a synchronous function, please use api.runOnBackend().
-     *
-     * @method
-     * @param {function|string} func - (synchronous) function to be executed on the backend
-     * @param {Array.<?>} params - list of parameters to the anonymous function to be sent to backend
-     * @returns {Promise<*>} return value of the executed function on the backend
-     */
-    this.runAsyncOnBackendWithManualTransactionHandling = async (func, params = []) => {
-        if (func?.constructor.name === "Function" || func?.startsWith?.("function")) {
-            toastService.showError(t("frontend_script_api.sync_warning"));
-        }
-
-        return await this.__runOnBackendInner(func, params, false);
-    };
-
-    /**
-     * This is a powerful search method - you can search by attributes and their values, e.g.:
-     * "#dateModified =* MONTH AND #log". See full documentation for all options at: https://triliumnext.github.io/Docs/Wiki/search.html
-     *
-     * @method
-     * @param {string} searchString
-     * @returns {Promise<FNote[]>}
-     */
-    this.searchForNotes = async searchString => {
-        return await searchService.searchForNotes(searchString);
-    };
-
-    /**
-     * This is a powerful search method - you can search by attributes and their values, e.g.:
-     * "#dateModified =* MONTH AND #log". See full documentation for all options at: https://triliumnext.github.io/Docs/Wiki/search.html
-     *
-     * @method
-     * @param {string} searchString
-     * @returns {Promise<FNote|null>}
-     */
-    this.searchForNote = async searchString => {
-        const notes = await this.searchForNotes(searchString);
-
-        return notes.length > 0 ? notes[0] : null;
-    };
-
-    /**
-     * Returns note by given noteId. If note is missing from the cache, it's loaded.
-     **
-     * @method
-     * @param {string} noteId
-     * @returns {Promise<FNote>}
-     */
-    this.getNote = async noteId => await froca.getNote(noteId);
-
-    /**
-     * Returns list of notes. If note is missing from the cache, it's loaded.
-     *
-     * This is often used to bulk-fill the cache with notes which would have to be picked one by one
-     * otherwise (by e.g. createLink())
-     *
-     * @method
-     * @param {string[]} noteIds
-     * @param {boolean} [silentNotFoundError] - don't report error if the note is not found
-     * @returns {Promise<FNote[]>}
-     */
-    this.getNotes = async (noteIds, silentNotFoundError = false) => await froca.getNotes(noteIds, silentNotFoundError);
-
-    /**
-     * Update frontend tree (note) cache from the backend.
-     *
-     * @method
-     * @param {string[]} noteIds
-     */
-    this.reloadNotes = async noteIds => await froca.reloadNotes(noteIds);
-
-    /**
-     * Instance name identifies particular Trilium instance. It can be useful for scripts
-     * if some action needs to happen on only one specific instance.
-     *
-     * @method
-     * @returns {string}
-     */
-    this.getInstanceName = () => window.glob.instanceName;
-
-    /**
-     * @method
-     * @param {Date} date
-     * @returns {string} date in YYYY-MM-DD format
-     */
-    this.formatDateISO = utils.formatDateISO;
-
-    /**
-     * @method
-     * @param {string} str
-     * @returns {Date} parsed object
-     */
-    this.parseDate = utils.parseDate;
-
-    /**
-     * Show an info toast message to the user.
-     *
-     * @method
-     * @param {string} message
-     */
-    this.showMessage = toastService.showMessage;
-
-    /**
-     * Show an error toast message to the user.
-     *
-     * @method
-     * @param {string} message
-     */
-    this.showError = toastService.showError;
-
-    /**
-     * Show an info dialog to the user.
-     *
-     * @method
-     * @param {string} message
-     * @returns {Promise}
-     */
-    this.showInfoDialog = dialogService.info;
-
-    /**
-     * Show confirm dialog to the user.
-     *
-     * @method
-     * @param {string} message
-     * @returns {Promise<boolean>} promise resolving to true if the user confirmed
-     */
-    this.showConfirmDialog = dialogService.confirm;
-
-    /**
-     * Show prompt dialog to the user.
-     *
-     * @method
-     * @param {object} props
-     * @param {string} props.title
-     * @param {string} props.message
-     * @param {string} props.defaultValue
-     * @returns {Promise<string>} promise resolving to the answer provided by the user
-     */
-    this.showPromptDialog = dialogService.prompt;
-
-    /**
-     * Trigger command. This is a very low-level API which should be avoided if possible.
-     *
-     * @method
-     * @param {string} name
-     * @param {object} data
-     */
-    this.triggerCommand = (name, data) => appContext.triggerCommand(name, data);
-
-    /**
-     * Trigger event. This is a very low-level API which should be avoided if possible.
-     *
-     * @method
-     * @param {string} name
-     * @param {object} data
-     */
-    this.triggerEvent = (name, data) => appContext.triggerEvent(name, data);
-
-    /**
-     * Create a note link (jQuery object) for given note.
-     *
-     * @method
-     * @param {string} notePath (or noteId)
-     * @param {object} [params]
-     * @param {boolean} [params.showTooltip=true] - enable/disable tooltip on the link
-     * @param {boolean} [params.showNotePath=false] - show also whole note's path as part of the link
-     * @param {boolean} [params.showNoteIcon=false] - show also note icon before the title
-     * @param {string} [params.title] - custom link tile with note's title as default
-     * @param {string} [params.title=] - custom link tile with note's title as default
-     * @returns {jQuery} - jQuery element with the link (wrapped in <span>)
-     */
-    this.createLink = linkService.createLink;
-
-    /** @deprecated - use api.createLink() instead */
-    this.createNoteLink = linkService.createLink;
-
-    /**
-     * Adds given text to the editor cursor
-     *
-     * @method
-     * @param {string} text - this must be clear text, HTML is not supported.
-     */
-    this.addTextToActiveContextEditor = text => appContext.triggerCommand('addTextToActiveEditor', {text});
-
-    /**
-     * @method
-     * @returns {FNote} active note (loaded into center pane)
-     */
-    this.getActiveContextNote = () => appContext.tabManager.getActiveContextNote();
-
-    /**
-     * @method
-     * @returns {NoteContext} - returns active context (split)
-     */
-    this.getActiveContext = () => appContext.tabManager.getActiveContext();
-
-    /**
-     * @method
-     * @returns {NoteContext} - returns active main context (first split in a tab, represents the tab as a whole)
-     */
-    this.getActiveMainContext = () => appContext.tabManager.getActiveMainContext();
-
-    /**
-     * @method
-     * @returns {NoteContext[]} - returns all note contexts (splits) in all tabs
-     */
-    this.getNoteContexts = () => appContext.tabManager.getNoteContexts();
-
-    /**
-     * @method
-     * @returns {NoteContext[]} - returns all main contexts representing tabs
-     */
-    this.getMainNoteContexts = () => appContext.tabManager.getMainNoteContexts();
-
-    /**
-     * See https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editor-Editor.html for documentation on the returned instance.
-     *
-     * @method
-     * @returns {Promise<BalloonEditor>} instance of CKEditor
-     */
-    this.getActiveContextTextEditor = () => appContext.tabManager.getActiveContext()?.getTextEditor();
-
-    /**
-     * See https://codemirror.net/doc/manual.html#api
-     *
-     * @method
-     * @returns {Promise<CodeMirror>} instance of CodeMirror
-     */
-    this.getActiveContextCodeEditor = () => appContext.tabManager.getActiveContext()?.getCodeEditor();
-
-    /**
-     * Get access to the widget handling note detail. Methods like `getWidgetType()` and `getTypeWidget()` to get to the
-     * implementation of actual widget type.
-     *
-     * @method
-     * @returns {Promise<NoteDetailWidget>}
-     */
-    this.getActiveNoteDetailWidget = () => new Promise(resolve => appContext.triggerCommand('executeInActiveNoteDetailWidget', {callback: resolve}));
-
-    /**
-     * @method
-     * @returns {Promise<string|null>} returns a note path of active note or null if there isn't active note
-     */
-    this.getActiveContextNotePath = () => appContext.tabManager.getActiveContextNotePath();
-
-    /**
-     * Returns component which owns the given DOM element (the nearest parent component in DOM tree)
-     *
-     * @method
-     * @param {Element} el - DOM element
-     * @returns {Component}
-     */
-    this.getComponentByEl = el => appContext.getComponentByEl(el);
-
-    /**
-     * @method
-     * @param {object} $el - jquery object on which to set up the tooltip
-     * @returns {Promise<void>}
-     */
-    this.setupElementTooltip = noteTooltipService.setupElementTooltip;
-
-    /**
-     * @method
-     * @param {string} noteId
-     * @param {boolean} protect - true to protect note, false to unprotect
-     * @returns {Promise<void>}
-     */
-    this.protectNote = async (noteId, protect) => {
-        await protectedSessionService.protectNote(noteId, protect, false);
-    };
-
-    /**
-     * @method
-     * @param {string} noteId
-     * @param {boolean} protect - true to protect subtree, false to unprotect
-     * @returns {Promise<void>}
-     */
-    this.protectSubTree = async (noteId, protect) => {
-        await protectedSessionService.protectNote(noteId, protect, true);
-    };
-
-    /**
-     * Returns date-note for today. If it doesn't exist, it is automatically created.
-     *
-     * @method
-     * @returns {Promise<FNote>}
-     */
-    this.getTodayNote = dateNotesService.getTodayNote;
-
-    /**
-     * Returns day note for a given date. If it doesn't exist, it is automatically created.
-     *
-     * @method
-     * @param {string} date - e.g. "2019-04-29"
-     * @returns {Promise<FNote>}
-     */
-    this.getDayNote = dateNotesService.getDayNote;
-
-    /**
-     * Returns day note for the first date of the week of the given date. If it doesn't exist, it is automatically created.
-     *
-     * @method
-     * @param {string} date - e.g. "2019-04-29"
-     * @returns {Promise<FNote>}
-     */
-    this.getWeekFirstDayNote = dateNotesService.getWeekFirstDayNote;
-
-    /**
-     * Returns month-note. If it doesn't exist, it is automatically created.
-     *
-     * @method
-     * @param {string} month - e.g. "2019-04"
-     * @returns {Promise<FNote>}
-     */
-    this.getMonthNote = dateNotesService.getMonthNote;
-
-    /**
-     * Returns year-note. If it doesn't exist, it is automatically created.
-     *
-     * @method
-     * @param {string} year - e.g. "2019"
-     * @returns {Promise<FNote>}
-     */
-    this.getYearNote = dateNotesService.getYearNote;
-
-    /**
-     * Hoist note in the current tab. See https://triliumnext.github.io/Docs/Wiki/note-hoisting.html
-     *
-     * @method
-     * @param {string} noteId - set hoisted note. 'root' will effectively unhoist
-     * @returns {Promise<void>}
-     */
-    this.setHoistedNoteId = (noteId) => {
-        const activeNoteContext = appContext.tabManager.getActiveContext();
-
-        if (activeNoteContext) {
-            activeNoteContext.setHoistedNoteId(noteId);
-        }
-    };
-
-    /**
-     * @method
-     * @param {string} keyboardShortcut - e.g. "ctrl+shift+a"
-     * @param {function} handler
-     * @param {string} [namespace] - specify namespace of the handler for the cases where call for bind may be repeated.
-     *                               If a handler with this ID exists, it's replaced by the new handler.
-     * @returns {Promise<void>}
-     */
-    this.bindGlobalShortcut = shortcutService.bindGlobalShortcut;
-
-    /**
-     * Trilium runs in a backend and frontend process, when something is changed on the backend from a script,
-     * frontend will get asynchronously synchronized.
-     *
-     * This method returns a promise which resolves once all the backend -> frontend synchronization is finished.
-     * Typical use case is when a new note has been created, we should wait until it is synced into frontend and only then activate it.
-     *
-     * @method
-     * @returns {Promise<void>}
-     */
-    this.waitUntilSynced = ws.waitForMaxKnownEntityChangeId;
-
-    /**
-     * This will refresh all currently opened notes which have included note specified in the parameter
-     *
-     * @param includedNoteId - noteId of the included note
-     * @returns {Promise<void>}
-     */
-    this.refreshIncludedNote = includedNoteId => appContext.triggerEvent('refreshIncludedNote', {noteId: includedNoteId});
-
-    /**
-     * Return randomly generated string of given length. This random string generation is NOT cryptographically secure.
-     *
-     * @method
-     * @param {int} length of the string
-     * @returns {string} random string
-     */
-    this.randomString = utils.randomString;
-
-    /**
-     * @method
-     * @param {int} size in bytes
-     * @return {string} formatted string
-     */
-    this.formatSize = utils.formatSize;
-
-    /**
-     * @method
-     * @param {int} size in bytes
-     * @return {string} formatted string
-     * @deprecated - use api.formatSize()
-     */
-    this.formatNoteSize = utils.formatSize;
-
-    this.logMessages = {};
-    this.logSpacedUpdates = {};
-
-    /**
-     * Log given message to the log pane in UI
-     *
-     * @param message
-     * @returns {void}
-     */
-    this.log = message => {
-        const {noteId} = this.startNote;
-
-        message = `${utils.now()}: ${message}`;
-
-        console.log(`Script ${noteId}: ${message}`);
-
-        this.logMessages[noteId] = this.logMessages[noteId] || [];
-        this.logSpacedUpdates[noteId] = this.logSpacedUpdates[noteId] || new SpacedUpdate(() => {
-            const messages = this.logMessages[noteId];
-            this.logMessages[noteId] = [];
-
-            appContext.triggerEvent("apiLogMessages", {noteId, messages});
-        }, 100);
-
-        this.logMessages[noteId].push(message);
-        this.logSpacedUpdates[noteId].scheduleUpdate();
-    };
-}
-
-export default FrontendScriptApi;
-
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - diff --git a/docs/frontend_api/styles/jsdoc-default.css b/docs/frontend_api/styles/jsdoc-default.css deleted file mode 100644 index 7d1729dc9..000000000 --- a/docs/frontend_api/styles/jsdoc-default.css +++ /dev/null @@ -1,358 +0,0 @@ -@font-face { - font-family: 'Open Sans'; - font-weight: normal; - font-style: normal; - src: url('../fonts/OpenSans-Regular-webfont.eot'); - src: - local('Open Sans'), - local('OpenSans'), - url('../fonts/OpenSans-Regular-webfont.eot?#iefix') format('embedded-opentype'), - url('../fonts/OpenSans-Regular-webfont.woff') format('woff'), - url('../fonts/OpenSans-Regular-webfont.svg#open_sansregular') format('svg'); -} - -@font-face { - font-family: 'Open Sans Light'; - font-weight: normal; - font-style: normal; - src: url('../fonts/OpenSans-Light-webfont.eot'); - src: - local('Open Sans Light'), - local('OpenSans Light'), - url('../fonts/OpenSans-Light-webfont.eot?#iefix') format('embedded-opentype'), - url('../fonts/OpenSans-Light-webfont.woff') format('woff'), - url('../fonts/OpenSans-Light-webfont.svg#open_sanslight') format('svg'); -} - -html -{ - overflow: auto; - background-color: #fff; - font-size: 14px; -} - -body -{ - font-family: 'Open Sans', sans-serif; - line-height: 1.5; - color: #4d4e53; - background-color: white; -} - -a, a:visited, a:active { - color: #0095dd; - text-decoration: none; -} - -a:hover { - text-decoration: underline; -} - -header -{ - display: block; - padding: 0px 4px; -} - -tt, code, kbd, samp { - font-family: Consolas, Monaco, 'Andale Mono', monospace; -} - -.class-description { - font-size: 130%; - line-height: 140%; - margin-bottom: 1em; - margin-top: 1em; -} - -.class-description:empty { - margin: 0; -} - -#main { - float: left; - width: 70%; -} - -article dl { - margin-bottom: 40px; -} - -article img { - max-width: 100%; -} - -section -{ - display: block; - background-color: #fff; - padding: 12px 24px; - border-bottom: 1px solid #ccc; - margin-right: 30px; -} - -.variation { - display: none; -} - -.signature-attributes { - font-size: 60%; - color: #aaa; - font-style: italic; - font-weight: lighter; -} - -nav -{ - display: block; - float: right; - margin-top: 28px; - width: 30%; - box-sizing: border-box; - border-left: 1px solid #ccc; - padding-left: 16px; -} - -nav ul { - font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif; - font-size: 100%; - line-height: 17px; - padding: 0; - margin: 0; - list-style-type: none; -} - -nav ul a, nav ul a:visited, nav ul a:active { - font-family: Consolas, Monaco, 'Andale Mono', monospace; - line-height: 18px; - color: #4D4E53; -} - -nav h3 { - margin-top: 12px; -} - -nav li { - margin-top: 6px; -} - -footer { - display: block; - padding: 6px; - margin-top: 12px; - font-style: italic; - font-size: 90%; -} - -h1, h2, h3, h4 { - font-weight: 200; - margin: 0; -} - -h1 -{ - font-family: 'Open Sans Light', sans-serif; - font-size: 48px; - letter-spacing: -2px; - margin: 12px 24px 20px; -} - -h2, h3.subsection-title -{ - font-size: 30px; - font-weight: 700; - letter-spacing: -1px; - margin-bottom: 12px; -} - -h3 -{ - font-size: 24px; - letter-spacing: -0.5px; - margin-bottom: 12px; -} - -h4 -{ - font-size: 18px; - letter-spacing: -0.33px; - margin-bottom: 12px; - color: #4d4e53; -} - -h5, .container-overview .subsection-title -{ - font-size: 120%; - font-weight: bold; - letter-spacing: -0.01em; - margin: 8px 0 3px 0; -} - -h6 -{ - font-size: 100%; - letter-spacing: -0.01em; - margin: 6px 0 3px 0; - font-style: italic; -} - -table -{ - border-spacing: 0; - border: 0; - border-collapse: collapse; -} - -td, th -{ - border: 1px solid #ddd; - margin: 0px; - text-align: left; - vertical-align: top; - padding: 4px 6px; - display: table-cell; -} - -thead tr -{ - background-color: #ddd; - font-weight: bold; -} - -th { border-right: 1px solid #aaa; } -tr > th:last-child { border-right: 1px solid #ddd; } - -.ancestors, .attribs { color: #999; } -.ancestors a, .attribs a -{ - color: #999 !important; - text-decoration: none; -} - -.clear -{ - clear: both; -} - -.important -{ - font-weight: bold; - color: #950B02; -} - -.yes-def { - text-indent: -1000px; -} - -.type-signature { - color: #aaa; -} - -.name, .signature { - font-family: Consolas, Monaco, 'Andale Mono', monospace; -} - -.details { margin-top: 14px; border-left: 2px solid #DDD; } -.details dt { width: 120px; float: left; padding-left: 10px; padding-top: 6px; } -.details dd { margin-left: 70px; } -.details ul { margin: 0; } -.details ul { list-style-type: none; } -.details li { margin-left: 30px; padding-top: 6px; } -.details pre.prettyprint { margin: 0 } -.details .object-value { padding-top: 0; } - -.description { - margin-bottom: 1em; - margin-top: 1em; -} - -.code-caption -{ - font-style: italic; - font-size: 107%; - margin: 0; -} - -.source -{ - border: 1px solid #ddd; - width: 80%; - overflow: auto; -} - -.prettyprint.source { - width: inherit; -} - -.source code -{ - font-size: 100%; - line-height: 18px; - display: block; - padding: 4px 12px; - margin: 0; - background-color: #fff; - color: #4D4E53; -} - -.prettyprint code span.line -{ - display: inline-block; -} - -.prettyprint.linenums -{ - padding-left: 70px; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; -} - -.prettyprint.linenums ol -{ - padding-left: 0; -} - -.prettyprint.linenums li -{ - border-left: 3px #ddd solid; -} - -.prettyprint.linenums li.selected, -.prettyprint.linenums li.selected * -{ - background-color: lightyellow; -} - -.prettyprint.linenums li * -{ - -webkit-user-select: text; - -moz-user-select: text; - -ms-user-select: text; - user-select: text; -} - -.params .name, .props .name, .name code { - color: #4D4E53; - font-family: Consolas, Monaco, 'Andale Mono', monospace; - font-size: 100%; -} - -.params td.description > p:first-child, -.props td.description > p:first-child -{ - margin-top: 0; - padding-top: 0; -} - -.params td.description > p:last-child, -.props td.description > p:last-child -{ - margin-bottom: 0; - padding-bottom: 0; -} - -.disabled { - color: #454545; -} diff --git a/docs/frontend_api/styles/prettify-jsdoc.css b/docs/frontend_api/styles/prettify-jsdoc.css deleted file mode 100644 index 5a2526e37..000000000 --- a/docs/frontend_api/styles/prettify-jsdoc.css +++ /dev/null @@ -1,111 +0,0 @@ -/* JSDoc prettify.js theme */ - -/* plain text */ -.pln { - color: #000000; - font-weight: normal; - font-style: normal; -} - -/* string content */ -.str { - color: #006400; - font-weight: normal; - font-style: normal; -} - -/* a keyword */ -.kwd { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* a comment */ -.com { - font-weight: normal; - font-style: italic; -} - -/* a type name */ -.typ { - color: #000000; - font-weight: normal; - font-style: normal; -} - -/* a literal value */ -.lit { - color: #006400; - font-weight: normal; - font-style: normal; -} - -/* punctuation */ -.pun { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* lisp open bracket */ -.opn { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* lisp close bracket */ -.clo { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* a markup tag name */ -.tag { - color: #006400; - font-weight: normal; - font-style: normal; -} - -/* a markup attribute name */ -.atn { - color: #006400; - font-weight: normal; - font-style: normal; -} - -/* a markup attribute value */ -.atv { - color: #006400; - font-weight: normal; - font-style: normal; -} - -/* a declaration */ -.dec { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* a variable name */ -.var { - color: #000000; - font-weight: normal; - font-style: normal; -} - -/* a function name */ -.fun { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* Specify class=linenums on a pre to get line numbering */ -ol.linenums { - margin-top: 0; - margin-bottom: 0; -} diff --git a/docs/frontend_api/styles/prettify-tomorrow.css b/docs/frontend_api/styles/prettify-tomorrow.css deleted file mode 100644 index b6f92a78d..000000000 --- a/docs/frontend_api/styles/prettify-tomorrow.css +++ /dev/null @@ -1,132 +0,0 @@ -/* Tomorrow Theme */ -/* Original theme - https://github.com/chriskempson/tomorrow-theme */ -/* Pretty printing styles. Used with prettify.js. */ -/* SPAN elements with the classes below are added by prettyprint. */ -/* plain text */ -.pln { - color: #4d4d4c; } - -@media screen { - /* string content */ - .str { - color: #718c00; } - - /* a keyword */ - .kwd { - color: #8959a8; } - - /* a comment */ - .com { - color: #8e908c; } - - /* a type name */ - .typ { - color: #4271ae; } - - /* a literal value */ - .lit { - color: #f5871f; } - - /* punctuation */ - .pun { - color: #4d4d4c; } - - /* lisp open bracket */ - .opn { - color: #4d4d4c; } - - /* lisp close bracket */ - .clo { - color: #4d4d4c; } - - /* a markup tag name */ - .tag { - color: #c82829; } - - /* a markup attribute name */ - .atn { - color: #f5871f; } - - /* a markup attribute value */ - .atv { - color: #3e999f; } - - /* a declaration */ - .dec { - color: #f5871f; } - - /* a variable name */ - .var { - color: #c82829; } - - /* a function name */ - .fun { - color: #4271ae; } } -/* Use higher contrast and text-weight for printable form. */ -@media print, projection { - .str { - color: #060; } - - .kwd { - color: #006; - font-weight: bold; } - - .com { - color: #600; - font-style: italic; } - - .typ { - color: #404; - font-weight: bold; } - - .lit { - color: #044; } - - .pun, .opn, .clo { - color: #440; } - - .tag { - color: #006; - font-weight: bold; } - - .atn { - color: #404; } - - .atv { - color: #060; } } -/* Style */ -/* -pre.prettyprint { - background: white; - font-family: Consolas, Monaco, 'Andale Mono', monospace; - font-size: 12px; - line-height: 1.5; - border: 1px solid #ccc; - padding: 10px; } -*/ - -/* Specify class=linenums on a pre to get line numbering */ -ol.linenums { - margin-top: 0; - margin-bottom: 0; } - -/* IE indents via margin-left */ -li.L0, -li.L1, -li.L2, -li.L3, -li.L4, -li.L5, -li.L6, -li.L7, -li.L8, -li.L9 { - /* */ } - -/* Alternate shading for lines */ -li.L1, -li.L3, -li.L5, -li.L7, -li.L9 { - /* */ } diff --git a/docs/frontend_api/widgets_basic_widget.js.html b/docs/frontend_api/widgets_basic_widget.js.html deleted file mode 100644 index e1abeeb7e..000000000 --- a/docs/frontend_api/widgets_basic_widget.js.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - JSDoc: Source: widgets/basic_widget.js - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Source: widgets/basic_widget.js

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - 
                                                                                                                                                                                                                                                                                                                                                                                                                                  import Component from "../components/component.js";
-import froca from "../services/froca.js";
-import { t } from "../services/i18n.js";
-import toastService from "../services/toast.js";
-
-/**
- * This is the base widget for all other widgets.
- *
- * For information on using widgets, see the tutorial {@tutorial widget_basics}.
- */
-class BasicWidget extends Component {
-    constructor() {
-        super();
-
-        this.attrs = {
-            style: ''
-        };
-        this.classes = [];
-
-        this.children = [];
-        this.childPositionCounter = 10;
-    }
-
-    child(...components) {
-        if (!components) {
-            return this;
-        }
-
-        super.child(...components);
-
-        for (const component of components) {
-            if (component.position === undefined) {
-                component.position = this.childPositionCounter;
-                this.childPositionCounter += 10;
-            }
-        }
-
-        this.children.sort((a, b) => a.position - b.position);
-
-        return this;
-    }
-
-    /**
-     * Conditionally adds the given components as children to this component.
-     * 
-     * @param {boolean} condition whether to add the components.
-     * @param  {...any} components the components to be added as children to this component provided the condition is truthy. 
-     * @returns self for chaining.
-     */
-    optChild(condition, ...components) {
-        if (condition) {
-            return this.child(...components);
-        } else {
-            return this;
-        }
-    }
-
-    id(id) {
-        this.attrs.id = id;
-        return this;
-    }
-
-    class(className) {
-        this.classes.push(className);
-        return this;
-    }
-
-    /**
-     * Sets the CSS attribute of the given name to the given value.
-     * 
-     * @param {string} name the name of the CSS attribute to set (e.g. `padding-left`).
-     * @param {string} value the value of the CSS attribute to set (e.g. `12px`).
-     * @returns self for chaining.
-     */
-    css(name, value) {
-        this.attrs.style += `${name}: ${value};`;
-        return this;
-    }
-
-    /**
-     * Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.
-     * 
-     * @param {boolean} condition `true` in order to apply the CSS, `false` to ignore it.
-     * @param {string} name the name of the CSS attribute to set (e.g. `padding-left`).
-     * @param {string} value the value of the CSS attribute to set (e.g. `12px`).
-     * @returns self for chaining.
-     */
-    optCss(condition, name, value) {
-        if (condition) {
-            return this.css(name, value);
-        }
-
-        return this;
-    }
-
-    contentSized() {
-        this.css("contain", "none");
-
-        return this;
-    }
-
-    collapsible() {
-        this.css('min-height', '0');
-        this.css('min-width', '0');
-        return this;
-    }
-
-    filling() {
-        this.css('flex-grow', '1');
-        return this;
-    }
-
-    /**
-     * Accepts a string of CSS to add with the widget.
-     * @param {string} block
-     * @returns {this} for chaining
-     */
-    cssBlock(block) {
-        this.cssEl = block;
-        return this;
-    }
-
-    render() {
-        try {
-            this.doRender();
-        } catch (e) {                        
-            this.logRenderingError(e);
-        }
-
-        this.$widget.attr('data-component-id', this.componentId);
-        this.$widget
-            .addClass('component')
-            .prop('component', this);
-
-        if (!this.isEnabled()) {
-            this.toggleInt(false);
-        }
-
-        if (this.cssEl) {
-            const css = this.cssEl.trim().startsWith('<style>') ? this.cssEl : `<style>${this.cssEl}</style>`;
-
-            this.$widget.append(css);
-        }
-
-        for (const key in this.attrs) {
-            if (key === 'style') {
-                if (this.attrs[key]) {
-                    let style = this.$widget.attr('style');
-                    style = style ? `${style}; ${this.attrs[key]}` : this.attrs[key];
-
-                    this.$widget.attr(key, style);
-                }
-            }
-            else {
-                this.$widget.attr(key, this.attrs[key]);
-            }
-        }
-
-        for (const className of this.classes) {
-            this.$widget.addClass(className);
-        }
-
-        return this.$widget;
-    }
-
-    logRenderingError(e) {
-        console.log("Got issue in widget ", this);
-        console.error(e);
-
-        let noteId = this._noteId;
-        if (this._noteId) {
-            froca.getNote(noteId, true).then((note) => {
-                toastService.showPersistent({
-                    title: t("toast.widget-error.title"),
-                    icon: "alert",
-                    message: t("toast.widget-error.message-custom", {
-                        id: noteId,
-                        title: note.title,
-                        message: e.message
-                    })
-                });
-            });
-            return;
-        }
-
-        toastService.showPersistent({
-            title: t("toast.widget-error.title"),
-            icon: "alert",
-            message: t("toast.widget-error.message-unknown", {
-                message: e.message
-            })
-        });
-    }
-
-    /**
-     * Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to `false` will cause the widget not to be displayed, however it will still be available on the DOM but hidden.
-     * @returns whether the widget is enabled.
-     */
-    isEnabled() {
-        return true;
-    }
-
-    /**
-     * Method used for rendering the widget.
-     *
-     * Your class should override this method.
-     * The method is expected to create a this.$widget containing jQuery object
-     */
-    doRender() {}
-
-    toggleInt(show) {
-        this.$widget.toggleClass('hidden-int', !show);
-    }
-
-    isHiddenInt() {
-        return this.$widget.hasClass('hidden-int');
-    }
-
-    toggleExt(show) {
-        this.$widget.toggleClass('hidden-ext', !show);
-    }
-
-    isHiddenExt() {
-        return this.$widget.hasClass('hidden-ext');
-    }
-
-    canBeShown() {
-        return !this.isHiddenInt() && !this.isHiddenExt();
-    }
-
-    isVisible() {
-        return this.$widget.is(":visible");
-    }
-
-    getPosition() {
-        return this.position;
-    }
-
-    remove() {
-        if (this.$widget) {
-            this.$widget.remove();
-        }
-    }
-
-    getClosestNtxId() {
-        if (this.$widget) {
-            return this.$widget.closest("[data-ntx-id]").attr("data-ntx-id");
-        }
-        else {
-            return null;
-        }
-    }
-
-    cleanup() {}
-}
-
-export default BasicWidget;
-
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - diff --git a/docs/frontend_api/widgets_note_context_aware_widget.js.html b/docs/frontend_api/widgets_note_context_aware_widget.js.html deleted file mode 100644 index 9af03bc6b..000000000 --- a/docs/frontend_api/widgets_note_context_aware_widget.js.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - JSDoc: Source: widgets/note_context_aware_widget.js - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Source: widgets/note_context_aware_widget.js

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - 
                                                                                                                                                                                                                                                                                                                                                                                                                                  import BasicWidget from "./basic_widget.js";
-import appContext from "../components/app_context.js";
-
-/**
- * This widget allows for changing and updating depending on the active note.
- * @extends {BasicWidget}
- */
-class NoteContextAwareWidget extends BasicWidget {
-    isNoteContext(ntxId) {
-        if (Array.isArray(ntxId)) {
-            return this.noteContext && ntxId.includes(this.noteContext.ntxId);
-        }
-        else {
-            return this.noteContext && this.noteContext.ntxId === ntxId;
-        }
-    }
-
-    isActiveNoteContext() {
-        return appContext.tabManager.getActiveContext() === this.noteContext;
-    }
-
-    isNote(noteId) {
-        return this.noteId === noteId;
-    }
-
-    /** @returns {FNote|undefined} */
-    get note() {
-        return this.noteContext?.note;
-    }
-
-    /** @returns {string|undefined} */
-    get noteId() {
-        return this.note?.noteId;
-    }
-
-    /** @returns {string|undefined} */
-    get notePath() {
-        return this.noteContext?.notePath;
-    }
-
-    /** @returns {string} */
-    get hoistedNoteId() {
-        return this.noteContext?.hoistedNoteId;
-    }
-
-    get ntxId() {
-        return this.noteContext?.ntxId;
-    }
-
-    /**
-     * Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to `false` will cause the widget not to be displayed, however it will still be available on the DOM but hidden.
-     * 
-     * <p>
-     * If the widget is not enabled, it will not receive `refreshWithNote` updates.
-     * 
-     * @returns {boolean} true when an active note exists
-     */
-    isEnabled() {
-        return !!this.note;
-    }
-
-    async refresh() {
-        if (this.isEnabled()) {
-            this.toggleInt(true);
-
-            try {
-                await this.refreshWithNote(this.note);
-            } catch (e) {
-                // Ignore errors when user is refreshing or navigating away.
-                if (e === "rejected by browser") {
-                    return;
-                }
-
-                throw e;
-            }
-        }
-        else {
-            this.toggleInt(false);
-        }
-    }
-
-    /**
-     * Override this method to be able to refresh your
-     * widget with each note.
-     * @param {FNote} note
-     * @returns {Promise<void>}
-     */
-    async refreshWithNote(note) {}
-
-    async noteSwitchedEvent({noteContext, notePath}) {
-        // if notePath does not match, then the noteContext has been switched to another note in the meantime
-        if (noteContext.notePath === notePath) {
-            await this.noteSwitched();
-        }
-    }
-
-    async noteSwitched() {
-        await this.refresh();
-    }
-
-    async activeContextChangedEvent({noteContext}) {
-        this.noteContext = noteContext;
-
-        await this.activeContextChanged();
-    }
-
-    async activeContextChanged() {
-        await this.refresh();
-    }
-
-    // when note is both switched and activated, this should not produce a double refresh
-    async noteSwitchedAndActivatedEvent({noteContext, notePath}) {
-        this.noteContext = noteContext;
-
-        // if notePath does not match, then the noteContext has been switched to another note in the meantime
-        if (this.notePath === notePath) {
-            await this.refresh();
-        }
-    }
-
-    setNoteContextEvent({noteContext}) {
-        /** @var {NoteContext} */
-        this.noteContext = noteContext;
-    }
-
-    async noteTypeMimeChangedEvent({noteId}) {
-        if (this.isNote(noteId)) {
-            await this.refresh();
-        }
-    }
-
-    async frocaReloadedEvent() {
-        await this.refresh();
-    }
-}
-
-export default NoteContextAwareWidget;
-
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - diff --git a/docs/frontend_api/widgets_right_panel_widget.js.html b/docs/frontend_api/widgets_right_panel_widget.js.html deleted file mode 100644 index 618a7ebdc..000000000 --- a/docs/frontend_api/widgets_right_panel_widget.js.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - - JSDoc: Source: widgets/right_panel_widget.js - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Source: widgets/right_panel_widget.js

                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - 
                                                                                                                                                                                                                                                                                                                                                                                                                                  import NoteContextAwareWidget from "./note_context_aware_widget.js";
-import toastService from "../services/toast.js";
-import { t } from "../services/i18n.js";
-
-const WIDGET_TPL = `
-<div class="card widget">
-    <div class="card-header">
-        <div class="card-header-title"></div>
-        <div class="card-header-buttons"></div>
-    </div>
-
-    <div id="[to be set]" class="body-wrapper">
-        <div class="card-body"></div>
-    </div>
-</div>`;
-
-/**
- * This widget manages rendering panels in the right-hand pane.
- * @extends {NoteContextAwareWidget}
- */
-class RightPanelWidget extends NoteContextAwareWidget {
-    /** Title to show in the panel. */
-    get widgetTitle() { return "Untitled widget"; }
-
-    get widgetButtons() { return []; }
-
-    get help() { return {}; }
-
-    constructor() {
-        super();
-
-        this.child(...this.widgetButtons);
-    }
-
-    /**
-     * Do not override this method unless you know what you're doing.
-     * Do not override this method unless you know what you're doing.
-     */
-    doRender() {
-        this.$widget = $(WIDGET_TPL);
-        this.contentSized();
-        this.$widget.find('[data-target]').attr('data-target', `#${this.componentId}`);
-
-        this.$bodyWrapper = this.$widget.find('.body-wrapper');
-        this.$bodyWrapper.attr('id', this.componentId); // for toggle to work we need id
-
-        this.$body = this.$bodyWrapper.find('.card-body');
-
-        this.$title = this.$widget.find('.card-header .card-header-title');
-        this.$title.text(this.widgetTitle);
-
-        this.$buttons = this.$widget.find('.card-header .card-header-buttons');
-        this.$buttons.empty();
-
-        for (const buttonWidget of this.children) {
-            this.$buttons.append(buttonWidget.render());
-        }
-
-        this.initialized = this.doRenderBody().catch(e => {
-            this.logRenderingError(e);
-        });
-    }
-
-    /**
-     * Method used for rendering the body of the widget (via existing this.$body)
-     *
-     * Your class should override this method.
-     * @returns {Promise|undefined} if widget needs async operation to initialize, it can return a Promise
-     */
-    async doRenderBody() {}
-}
-
-export default RightPanelWidget;
-
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - - - diff --git a/typedoc.json b/typedoc.json index 3e8518b3a..c62847d07 100644 --- a/typedoc.json +++ b/typedoc.json @@ -10,7 +10,7 @@ "outputs": [ { "name": "html", - "path": "./docs/backend_api" + "path": "./docs/Script API" } ] }