diff --git a/docs/Script API/classes/Backend_Script_API.AbstractBeccaEntity.html b/docs/Script API/classes/Backend_Script_API.AbstractBeccaEntity.html index cc256f436..f10f769bd 100644 --- a/docs/Script API/classes/Backend_Script_API.AbstractBeccaEntity.html +++ b/docs/Script API/classes/Backend_Script_API.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/Script API/classes/Backend_Script_API.BAttachment.html b/docs/Script API/classes/Backend_Script_API.BAttachment.html index 5ce2f637d..c3b43f44f 100644 --- a/docs/Script API/classes/Backend_Script_API.BAttachment.html +++ b/docs/Script API/classes/Backend_Script_API.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/Script API/classes/Backend_Script_API.BAttribute.html b/docs/Script API/classes/Backend_Script_API.BAttribute.html index 5c43e3d22..b782f1a6b 100644 --- a/docs/Script API/classes/Backend_Script_API.BAttribute.html +++ b/docs/Script API/classes/Backend_Script_API.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/Script API/classes/Backend_Script_API.BBranch.html b/docs/Script API/classes/Backend_Script_API.BBranch.html index 2b78b4317..bda9fe179 100644 --- a/docs/Script API/classes/Backend_Script_API.BBranch.html +++ b/docs/Script API/classes/Backend_Script_API.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/Script API/classes/Backend_Script_API.BEtapiToken.html b/docs/Script API/classes/Backend_Script_API.BEtapiToken.html index d3e302d78..d179a0ce6 100644 --- a/docs/Script API/classes/Backend_Script_API.BEtapiToken.html +++ b/docs/Script API/classes/Backend_Script_API.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/Script API/classes/Backend_Script_API.BNote.html b/docs/Script API/classes/Backend_Script_API.BNote.html index 3ef444d79..69e7cfb64 100644 --- a/docs/Script API/classes/Backend_Script_API.BNote.html +++ b/docs/Script API/classes/Backend_Script_API.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/Script API/classes/Backend_Script_API.BOption.html b/docs/Script API/classes/Backend_Script_API.BOption.html index 9aaffc547..c4b144e34 100644 --- a/docs/Script API/classes/Backend_Script_API.BOption.html +++ b/docs/Script API/classes/Backend_Script_API.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/Script API/classes/Backend_Script_API.BRecentNote.html b/docs/Script API/classes/Backend_Script_API.BRecentNote.html index 6d3b4ba90..ffca437c1 100644 --- a/docs/Script API/classes/Backend_Script_API.BRecentNote.html +++ b/docs/Script API/classes/Backend_Script_API.BRecentNote.html @@ -1,5 +1,5 @@ BRecentNote | trilium
            trilium
              Preparing search index...

              Class BRecentNote

              RecentNote represents recently visited note.

              -

              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
              noteId: string
              notePath: string
              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
              noteId: string
              notePath: string
              utcDateCreated: string
              utcDateModified?: string

              Accessors

              Methods

              Protected_getContent

              Protected_setContent

              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/Script API/classes/Backend_Script_API.BRevision.html b/docs/Script API/classes/Backend_Script_API.BRevision.html index a1af0a477..bf4542035 100644 --- a/docs/Script API/classes/Backend_Script_API.BRevision.html +++ b/docs/Script API/classes/Backend_Script_API.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/Script API/classes/Backend_Script_API._internal_.SpacedUpdate.html b/docs/Script API/classes/Backend_Script_API._internal_.SpacedUpdate.html index 4acea65ec..061234561 100644 --- a/docs/Script 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/Script API/classes/Backend_Script_API._internal_.TaskContext.html b/docs/Script API/classes/Backend_Script_API._internal_.TaskContext.html index 4b4608923..f974c3c67 100644 --- a/docs/Script 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/Script API/classes/Backend_Script_API._internal_.default.html b/docs/Script API/classes/Backend_Script_API._internal_.default.html index bea11c638..3e24f45f6 100644 --- a/docs/Script 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

                          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

                          Settings

                          Member Visibility

                          On This Page

                          Constructors
                          Properties
                          Methods
                          diff --git a/docs/Script API/classes/Frontend_Script_API.BasicWidget.html b/docs/Script API/classes/Frontend_Script_API.BasicWidget.html index 17b7a6296..b427531d4 100644 --- a/docs/Script API/classes/Frontend_Script_API.BasicWidget.html +++ b/docs/Script API/classes/Frontend_Script_API.BasicWidget.html @@ -1,6 +1,6 @@ BasicWidget | trilium
                          trilium
                            Preparing search index...

                            Class BasicWidget

                            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

                            • 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

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

                              -

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

                              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/Script API/classes/Frontend_Script_API.FAttachment.html b/docs/Script API/classes/Frontend_Script_API.FAttachment.html index fbe59ad36..2e56f94ae 100644 --- a/docs/Script API/classes/Frontend_Script_API.FAttachment.html +++ b/docs/Script API/classes/Frontend_Script_API.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/Script API/classes/Frontend_Script_API.FAttribute.html b/docs/Script API/classes/Frontend_Script_API.FAttribute.html index a52553cbd..1ece5e5bc 100644 --- a/docs/Script API/classes/Frontend_Script_API.FAttribute.html +++ b/docs/Script API/classes/Frontend_Script_API.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/Script API/classes/Frontend_Script_API.FBranch.html b/docs/Script API/classes/Frontend_Script_API.FBranch.html index a59899d16..6931ea8ef 100644 --- a/docs/Script API/classes/Frontend_Script_API.FBranch.html +++ b/docs/Script API/classes/Frontend_Script_API.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/Script API/classes/Frontend_Script_API.FNote.html b/docs/Script API/classes/Frontend_Script_API.FNote.html index 0df63a71d..03827d96b 100644 --- a/docs/Script API/classes/Frontend_Script_API.FNote.html +++ b/docs/Script API/classes/Frontend_Script_API.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,85 @@ 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

                                    • Executes this FNote as a front-end or back-end script.

                                      +

                                      Returns Promise<any>

                                      a promise that resolves when the script has been run. Additionally, for front-end notes, the promise will contain the value that is returned by the script.

                                      +

                                      an Error if the note has an incorrect note type or MIME for execution.

                                      +

                                    • 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/Script API/classes/Frontend_Script_API.NoteContextAwareWidget.html b/docs/Script API/classes/Frontend_Script_API.NoteContextAwareWidget.html index c0f3e6a93..987483199 100644 --- a/docs/Script API/classes/Frontend_Script_API.NoteContextAwareWidget.html +++ b/docs/Script API/classes/Frontend_Script_API.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

                                      • 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

                                      • 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/Script API/classes/Frontend_Script_API.RightPanelWidget.html b/docs/Script API/classes/Frontend_Script_API.RightPanelWidget.html index d1d92cbab..992524915 100644 --- a/docs/Script API/classes/Frontend_Script_API.RightPanelWidget.html +++ b/docs/Script API/classes/Frontend_Script_API.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/Script API/classes/Frontend_Script_API._internal_.NoteContext.html b/docs/Script API/classes/Frontend_Script_API._internal_.NoteContext.html index c84a15ce1..8abce5394 100644 --- a/docs/Script 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/Script API/classes/Frontend_Script_API._internal_.TypedBasicWidget.html b/docs/Script API/classes/Frontend_Script_API._internal_.TypedBasicWidget.html index 45a796b3f..dc776206e 100644 --- a/docs/Script API/classes/Frontend_Script_API._internal_.TypedBasicWidget.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.TypedBasicWidget.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

                                        _noteId _position $widget @@ -49,24 +49,24 @@ event / command is executed in all components - by simply awaiting the tri toggleInt triggerCommand triggerEvent -

                                        Constructors

                                        Properties

                                        _noteId

                                        _noteId: string

                                        _position

                                        _position: number
                                        $widget: JQuery<HTMLElement>
                                        attrs: Record<string, string>
                                        children: T[]
                                        componentId: string
                                        initialized: null | Promise<void>
                                        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
                                        $widget: JQuery<HTMLElement>
                                        attrs: Record<string, string>
                                        children: T[]
                                        componentId: string
                                        initialized: null | Promise<void>
                                        parent?: TypedComponent<any>

                                        Accessors

                                        Methods

                                        • 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: T[]

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

                                          Returns TypedBasicWidget<T>

                                          self for chaining.

                                          -

                                        • 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 TypedBasicWidget<T>

                                          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/Script API/classes/Frontend_Script_API._internal_.TypedComponent.html b/docs/Script API/classes/Frontend_Script_API._internal_.TypedComponent.html index 11c754a85..f377c28ca 100644 --- a/docs/Script 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/Script API/classes/Frontend_Script_API._internal_.default-1.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-1.html index 55192c533..770cde33c 100644 --- a/docs/Script API/classes/Frontend_Script_API._internal_.default-1.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default-1.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/Script API/classes/Frontend_Script_API._internal_.default-2.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-2.html index f709dd65f..793ee4383 100644 --- a/docs/Script API/classes/Frontend_Script_API._internal_.default-2.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default-2.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/Script API/classes/Frontend_Script_API._internal_.default-3.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-3.html index afecba6a5..e24317b32 100644 --- a/docs/Script 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/Script API/classes/Frontend_Script_API._internal_.default-4.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-4.html index 6a90cd92c..804f895b9 100644 --- a/docs/Script API/classes/Frontend_Script_API._internal_.default-4.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default-4.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/Script API/classes/Frontend_Script_API._internal_.default-5.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-5.html index ab7ee6c0a..d62defce5 100644 --- a/docs/Script 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 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/Script API/classes/Frontend_Script_API._internal_.default-6.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-6.html index 998f4d2e9..a35ca5d4f 100644 --- a/docs/Script API/classes/Frontend_Script_API._internal_.default-6.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default-6.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/Script API/classes/Frontend_Script_API._internal_.default-7.html b/docs/Script API/classes/Frontend_Script_API._internal_.default-7.html index 31f0f9107..96ea38305 100644 --- a/docs/Script API/classes/Frontend_Script_API._internal_.default-7.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default-7.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/Script API/classes/Frontend_Script_API._internal_.default.html b/docs/Script API/classes/Frontend_Script_API._internal_.default.html index 8018746e7..66503d50d 100644 --- a/docs/Script API/classes/Frontend_Script_API._internal_.default.html +++ b/docs/Script API/classes/Frontend_Script_API._internal_.default.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/Script API/enums/Frontend_Script_API._internal_.FancytreeClickFolderMode.html b/docs/Script API/enums/Frontend_Script_API._internal_.FancytreeClickFolderMode.html index 217855bab..ebcc274ff 100644 --- a/docs/Script 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/Script API/enums/Frontend_Script_API._internal_.FancytreeSelectMode.html b/docs/Script API/enums/Frontend_Script_API._internal_.FancytreeSelectMode.html index 127e9f3c2..bc2212997 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API.Api.html b/docs/Script API/interfaces/Backend_Script_API.Api.html index 4c8e07e7c..1e3e51811 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.AttachmentOpts.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AttachmentOpts.html index 0ce89854f..7274333f8 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.AttachmentRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AttachmentRow.html index 63608ffbf..1a8f3c5a0 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.AttributeRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.AttributeRow.html index 33112b240..7fda6c546 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.BranchRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.BranchRow.html index 9a5610e59..dc4df47ad 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.CloneResponse.html b/docs/Script API/interfaces/Backend_Script_API._internal_.CloneResponse.html index d36ee9942..349a8b20e 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-1.html b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-1.html index 76a276078..76fb70213 100644 --- a/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-1.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-1.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/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-2.html b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-2.html index dee57d6b4..1f5391eea 100644 --- a/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-2.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-2.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/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-3.html b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts-3.html index 63ffc12d5..ab2e656c7 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.ContentOpts.html b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts.html index 548811d04..dd1cc498c 100644 --- a/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.ContentOpts.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/Script API/interfaces/Backend_Script_API._internal_.ConvertOpts.html b/docs/Script API/interfaces/Backend_Script_API._internal_.ConvertOpts.html index 258136f41..4c0553582 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.DefinitionObject.html b/docs/Script API/interfaces/Backend_Script_API._internal_.DefinitionObject.html index 7165249b1..fee078d1a 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.EtapiTokenRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.EtapiTokenRow.html index df789c788..c222b04a1 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.GetByIdOpts.html b/docs/Script API/interfaces/Backend_Script_API._internal_.GetByIdOpts.html index ec7f43e4d..c6f11a7b5 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.NoteAndBranch.html b/docs/Script API/interfaces/Backend_Script_API._internal_.NoteAndBranch.html index 14400370c..e0533c964 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.NoteParams.html b/docs/Script API/interfaces/Backend_Script_API._internal_.NoteParams.html index 3c857fb7c..0e348bf62 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.NotePathRecord.html b/docs/Script API/interfaces/Backend_Script_API._internal_.NotePathRecord.html index a55aece3f..2d14d3a1f 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.NotePojo.html b/docs/Script API/interfaces/Backend_Script_API._internal_.NotePojo.html index b90f6e9c2..b21a7285f 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.NoteRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.NoteRow.html index 4a76ad6bf..4e4c07f81 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.OptionRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.OptionRow.html index bed396607..51da7fafc 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.RecentNoteRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.RecentNoteRow.html index 525355b15..da3e48db1 100644 --- a/docs/Script API/interfaces/Backend_Script_API._internal_.RecentNoteRow.html +++ b/docs/Script API/interfaces/Backend_Script_API._internal_.RecentNoteRow.html @@ -1,4 +1,4 @@ -RecentNoteRow | trilium
                                                                                                                                                trilium
                                                                                                                                                  Preparing search index...

                                                                                                                                                  Interface RecentNoteRow

                                                                                                                                                  interface RecentNoteRow {
                                                                                                                                                      noteId: string;
                                                                                                                                                      notePath: string;
                                                                                                                                                      utcDateCreated?: string;
                                                                                                                                                  }
                                                                                                                                                  Index

                                                                                                                                                  Properties

                                                                                                                                                  noteId +RecentNoteRow | trilium
                                                                                                                                                  trilium
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Interface RecentNoteRow

                                                                                                                                                    interface RecentNoteRow {
                                                                                                                                                        noteId: string;
                                                                                                                                                        notePath: string;
                                                                                                                                                        utcDateCreated?: string;
                                                                                                                                                    }
                                                                                                                                                    Index

                                                                                                                                                    Properties

                                                                                                                                                    noteId notePath utcDateCreated? -

                                                                                                                                                    Properties

                                                                                                                                                    noteId: string
                                                                                                                                                    notePath: string
                                                                                                                                                    utcDateCreated?: string

                                                                                                                                                    Settings

                                                                                                                                                    Member Visibility

                                                                                                                                                    On This Page

                                                                                                                                                    Properties
                                                                                                                                                    +

                                                                                                                                                    Properties

                                                                                                                                                    noteId: string
                                                                                                                                                    notePath: string
                                                                                                                                                    utcDateCreated?: string

                                                                                                                                                    Settings

                                                                                                                                                    Member Visibility

                                                                                                                                                    On This Page

                                                                                                                                                    Properties
                                                                                                                                                    diff --git a/docs/Script API/interfaces/Backend_Script_API._internal_.Relationship.html b/docs/Script API/interfaces/Backend_Script_API._internal_.Relationship.html index 3a8aa98f2..0b5f39744 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.RevisionRow.html b/docs/Script API/interfaces/Backend_Script_API._internal_.RevisionRow.html index 1963af480..db9d70487 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.SavingOpts.html b/docs/Script API/interfaces/Backend_Script_API._internal_.SavingOpts.html index 71fbce427..90fafeb4e 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.SearchParams.html b/docs/Script API/interfaces/Backend_Script_API._internal_.SearchParams.html index fa92cfe63..1d7ebd3d9 100644 --- a/docs/Script 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/Script API/interfaces/Backend_Script_API._internal_.TaskData.html b/docs/Script API/interfaces/Backend_Script_API._internal_.TaskData.html index 23119120d..2dd7ed269 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API.Api.html b/docs/Script API/interfaces/Frontend_Script_API.Api.html index 2712bc97d..f80aa455e 100644 --- a/docs/Script 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 BasicWidget;
                                                                                                                                                                            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 BasicWidget;
                                                                                                                                                                              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 BasicWidget
                                                                                                                                                                          bindGlobalShortcut: (
                                                                                                                                                                              keyboardShortcut: string,
                                                                                                                                                                              handler: null | Handler,
                                                                                                                                                                              namespace?: null | string,
                                                                                                                                                                          ) => void

                                                                                                                                                                          Type declaration

                                                                                                                                                                          BasicWidget: typeof BasicWidget
                                                                                                                                                                          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/Script API/interfaces/Frontend_Script_API._internal_.AddToToolbarOpts.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.AddToToolbarOpts.html index 5c3bfbe8f..253c83ff1 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.Attribute.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Attribute.html index 66995fbb8..028210ebf 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.CKEvent.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.CKEvent.html index c95a059fb..e6e504723 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.CKNode.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.CKNode.html index 8aa080df6..d9ad0e8c1 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.CodeMirrorInstance.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.CodeMirrorInstance.html index 99f53b3b5..7b975cc05 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.CommandData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.CommandData.html index b45be6eb2..f4676f7f3 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.ConfirmDialogOptions.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ConfirmDialogOptions.html index 3d5a1bd88..e01d366b4 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.ConfirmWithMessageOptions.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ConfirmWithMessageOptions.html index f384cacb0..b17a5a877 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.ConfirmWithTitleOptions.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ConfirmWithTitleOptions.html index b7b463baf..95dfa2bdf 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.ContextMenuCommandData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ContextMenuCommandData.html index 7d1df17fe..61287e3a3 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.CreateLinkOptions.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.CreateLinkOptions.html index a7316492a..d5fb228a0 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.DefinitionObject.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.DefinitionObject.html index 1de6e1309..15b24698b 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.DragAndDrop5.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.DragAndDrop5.html index 6124ae154..f079b0acb 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.EventData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.EventData.html index dc00bfed3..593a2abc3 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.ExecuteCommandData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ExecuteCommandData.html index 94f09e0cb..ed1efa942 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.FAttachmentRow.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.FAttachmentRow.html index d0d90157e..f296181e3 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.FAttributeRow.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.FAttributeRow.html index 1d6f574c6..1309d39ef 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.FBranchRow.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.FBranchRow.html index d03456e6c..42d33dba0 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.FNoteRow.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.FNoteRow.html index 10ce4065e..5d6607cbf 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.Fancytree.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Fancytree.html index 7c45b90c1..3107f97c7 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.FancytreeEvents.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.FancytreeEvents.html index 5c1375a4d..759582bbd 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.FancytreeNode.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.FancytreeNode.html index 965a194a5..f05f77bf1 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.FancytreeOptions.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.FancytreeOptions.html index 14e13f51c..f9f95536b 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.Filter.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Filter.html index 42d0c0d4a..99b9e7c73 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.Froca.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Froca.html index 0853f46d3..f35ba8a4e 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.List.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.List.html index f0d5e18f4..029fcd2b4 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.Marker.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Marker.html index 26c8f1f39..07a127f0b 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.MentionConfig.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.MentionConfig.html index b96341fdb..aca929b1e 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.MentionItem.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.MentionItem.html index c8e75b049..4e2b1299c 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.NodeData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.NodeData.html index 4567fca06..cdfe94554 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.NodePatch.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.NodePatch.html index afb147cbc..630c4e8fb 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.NoteCommandData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.NoteCommandData.html index 743b20f4b..ae6393f62 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.NoteMetaData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.NoteMetaData.html index c66b41979..86b103580 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.NotePathRecord.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.NotePathRecord.html index bef56af7d..7fc2f54bd 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.NoteSwitchedContext.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.NoteSwitchedContext.html index 6e3f322d7..4bb9341c7 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.PersistData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.PersistData.html index c03ed749d..4fb0fa670 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.PromptDialogOptions.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.PromptDialogOptions.html index dbba522af..8a0af7631 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.ResolveOptions.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ResolveOptions.html index 438383c10..cda91df94 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.SetNoteOpts.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.SetNoteOpts.html index b94dcdb22..a65553d79 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.ShownCallbackData.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ShownCallbackData.html index 634b6a490..e39c9d5d8 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.Table.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Table.html index b3dc4f9ce..158818f24 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.TextEditor.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.TextEditor.html index 73509a96b..b9d659cbc 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.TextNode.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.TextNode.html index 1860d1ced..09e54e56a 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.TextPosition.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.TextPosition.html index 497c183db..ed6531f59 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.TextRange.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.TextRange.html index ec84491f1..916dc8b6b 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.TranslationTable.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.TranslationTable.html index ac0d1f05b..18a9a48b4 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.ViewScope.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.ViewScope.html index a1f31bc10..b5f72a732 100644 --- a/docs/Script 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/Script API/interfaces/Frontend_Script_API._internal_.Writer.html b/docs/Script API/interfaces/Frontend_Script_API._internal_.Writer.html index f9ebd7ec9..7a7321aab 100644 --- a/docs/Script 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/Script API/types/Backend_Script_API._internal_.AttributeType.html b/docs/Script API/types/Backend_Script_API._internal_.AttributeType.html index 793952bfc..d4e91ef8e 100644 --- a/docs/Script 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/Script API/types/Backend_Script_API._internal_.Updater.html b/docs/Script API/types/Backend_Script_API._internal_.Updater.html index cce607ffa..717a60585 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.AttributeType.html b/docs/Script API/types/Frontend_Script_API._internal_.AttributeType.html index 322386f06..e9bf461c7 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.CommandAndEventMappings.html b/docs/Script API/types/Frontend_Script_API._internal_.CommandAndEventMappings.html index d503cc922..35d68e802 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.CommandMappings.html b/docs/Script API/types/Frontend_Script_API._internal_.CommandMappings.html index 49e5b5efa..fed57c022 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.CommandNames.html b/docs/Script API/types/Frontend_Script_API._internal_.CommandNames.html index a6b537b3f..eb3234419 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.ConfirmDialogCallback.html b/docs/Script API/types/Frontend_Script_API._internal_.ConfirmDialogCallback.html index a4058e575..3fb49a8da 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.ConfirmDialogResult.html b/docs/Script API/types/Frontend_Script_API._internal_.ConfirmDialogResult.html index dc2da3405..8fcf20de5 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.ElementType.html b/docs/Script API/types/Frontend_Script_API._internal_.ElementType.html index 7579539e0..276513d13 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.EventData.html b/docs/Script API/types/Frontend_Script_API._internal_.EventData.html index 81434c6a7..84369b98c 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.EventListener.html b/docs/Script API/types/Frontend_Script_API._internal_.EventListener.html index 52207c1ae..01c7a9ae4 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.EventMappings.html b/docs/Script API/types/Frontend_Script_API._internal_.EventMappings.html index 632b4e27d..d44c4c38a 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.EventNames.html b/docs/Script API/types/Frontend_Script_API._internal_.EventNames.html index ded562984..1aa35cd35 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.EventOnlyNames.html b/docs/Script API/types/Frontend_Script_API._internal_.EventOnlyNames.html index 249ea6683..5cec33bc3 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.Func.html b/docs/Script API/types/Frontend_Script_API._internal_.Func.html index a3b63f3d8..4f7c907f2 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.GetTextEditorCallback.html b/docs/Script API/types/Frontend_Script_API._internal_.GetTextEditorCallback.html index a5d5c1799..2f5f85a91 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.Handler.html b/docs/Script API/types/Frontend_Script_API._internal_.Handler.html index 5ae4d4092..ef21dafad 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.LabelType.html b/docs/Script API/types/Frontend_Script_API._internal_.LabelType.html index d9cea9d61..3eff82a46 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.Multiplicity.html b/docs/Script API/types/Frontend_Script_API._internal_.Multiplicity.html index 31452b4f4..dfc72588c 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.NoteType.html b/docs/Script API/types/Frontend_Script_API._internal_.NoteType.html index 8957448e2..5404aece1 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.PromptShownDialogCallback.html b/docs/Script API/types/Frontend_Script_API._internal_.PromptShownDialogCallback.html index 3c75edbeb..1788be95b 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.Screen.html b/docs/Script API/types/Frontend_Script_API._internal_.Screen.html index cd00ccb78..6fef997f3 100644 --- a/docs/Script 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/Script API/types/Frontend_Script_API._internal_.SqlExecuteResults.html b/docs/Script API/types/Frontend_Script_API._internal_.SqlExecuteResults.html index d2297dca8..191997e0b 100644 --- a/docs/Script 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/Script API/variables/Backend_Script_API.api.html b/docs/Script API/variables/Backend_Script_API.api.html index c93516062..2d863860c 100644 --- a/docs/Script 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 index 773722c1c..bd4399eb2 100644 --- a/docs/Script API/variables/Frontend_Script_API.api.html +++ b/docs/Script API/variables/Frontend_Script_API.api.html @@ -1 +1 @@ -api | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                      Variable apiConst

                                                                                                                                                                                                                                                                                                                                                                                                                                      api: Api = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                      +api | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                        Variable apiConst

                                                                                                                                                                                                                                                                                                                                                                                                                                        api: Api = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/src/public/app/entities/fnote.ts b/src/public/app/entities/fnote.ts index e2a13852e..068636efa 100644 --- a/src/public/app/entities/fnote.ts +++ b/src/public/app/entities/fnote.ts @@ -952,6 +952,12 @@ class FNote { return null; } + /** + * Executes this {@link FNote} as a front-end or back-end script. + * + * @throws an {@link Error} if the note has an incorrect note type or MIME for execution. + * @returns a promise that resolves when the script has been run. Additionally, for front-end notes, the promise will contain the value that is returned by the script. + */ 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`);