From 956682f2c731047232e7d23c1544f452de868ef8 Mon Sep 17 00:00:00 2001 From: zadam Date: Fri, 17 Feb 2023 16:15:58 +0100 Subject: [PATCH] update docs --- docs/backend_api/AbstractBeccaEntity.html | 52 +- docs/backend_api/BAttribute.html | 107 +- docs/backend_api/BBranch.html | 112 +- docs/backend_api/BEtapiToken.html | 82 +- docs/backend_api/BNote.html | 1016 +++++++++++++-- docs/backend_api/BNoteRevision.html | 127 +- docs/backend_api/BOption.html | 72 +- docs/backend_api/BRecentNote.html | 67 +- docs/backend_api/BackendScriptApi.html | 793 ++++++------ docs/backend_api/index.html | 2 +- docs/backend_api/module-sql.html | 37 +- docs/frontend_api/FAttribute.html | 52 +- docs/frontend_api/FBranch.html | 62 +- docs/frontend_api/FNote.html | 577 +++++++-- docs/frontend_api/FNoteComplement.html | 52 +- docs/frontend_api/FrontendScriptApi.html | 1393 ++++++++------------- docs/frontend_api/index.html | 2 +- package-lock.json | 14 +- package.json | 2 +- 19 files changed, 3056 insertions(+), 1565 deletions(-) diff --git a/docs/backend_api/AbstractBeccaEntity.html b/docs/backend_api/AbstractBeccaEntity.html index c520b336a..e13c799bc 100644 --- a/docs/backend_api/AbstractBeccaEntity.html +++ b/docs/backend_api/AbstractBeccaEntity.html @@ -90,6 +90,11 @@ + +
Source:
+
@@ -175,6 +180,11 @@ + +
Source:
+
@@ -246,6 +256,11 @@ + +
Source:
+
@@ -325,6 +340,11 @@ + +
Source:
+
@@ -404,6 +424,11 @@ + +
Source:
+
@@ -483,6 +508,11 @@ + +
Source:
+
@@ -562,6 +592,11 @@ + +
Source:
+
@@ -641,6 +676,11 @@ + +
Source:
+
@@ -790,6 +830,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' + +
Source:
+
@@ -873,6 +918,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' + +
Source:
+
@@ -941,7 +991,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/BAttribute.html b/docs/backend_api/BAttribute.html index a2d37d4c5..8f6af88c6 100644 --- a/docs/backend_api/BAttribute.html +++ b/docs/backend_api/BAttribute.html @@ -91,6 +91,11 @@ and relation (representing named relationship between source and target note)Source: +
@@ -197,6 +202,11 @@ and relation (representing named relationship between source and target note)Source: +
@@ -256,6 +266,11 @@ and relation (representing named relationship between source and target note)Source: +
+ @@ -318,6 +333,11 @@ and relation (representing named relationship between source and target note)Source: +
@@ -381,6 +401,11 @@ and relation (representing named relationship between source and target note)Source: +
@@ -444,6 +469,11 @@ and relation (representing named relationship between source and target note)Source: +
@@ -507,6 +537,11 @@ and relation (representing named relationship between source and target note)Source: +
@@ -570,6 +605,11 @@ and relation (representing named relationship between source and target note)Source: +
@@ -633,6 +673,11 @@ and relation (representing named relationship between source and target note)Source: +
@@ -696,6 +741,11 @@ and relation (representing named relationship between source and target note)Source: +
@@ -773,6 +823,11 @@ and relation (representing named relationship between source and target note)Source: +
+ @@ -857,6 +912,11 @@ and relation (representing named relationship between source and target note)Source: +
+ @@ -941,6 +1001,11 @@ and relation (representing named relationship between source and target note)Source: +
+ @@ -1025,6 +1090,11 @@ and relation (representing named relationship between source and target note)Source: +
+ @@ -1103,6 +1173,11 @@ and relation (representing named relationship between source and target note)Source: +
@@ -1209,6 +1284,11 @@ and relation (representing named relationship between source and target note)Source: +
+ @@ -1287,6 +1367,11 @@ and relation (representing named relationship between source and target note)Source: +
@@ -1393,6 +1478,11 @@ and relation (representing named relationship between source and target note)Source: +
+ @@ -1471,6 +1561,11 @@ and relation (representing named relationship between source and target note)Source: +
@@ -1644,6 +1739,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' +
Source:
+
+ @@ -1732,6 +1832,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' +
Source:
+
+ @@ -1799,7 +1904,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/BBranch.html b/docs/backend_api/BBranch.html index e12dbf829..ae6e4e014 100644 --- a/docs/backend_api/BBranch.html +++ b/docs/backend_api/BBranch.html @@ -94,6 +94,11 @@ Always check noteId instead. + +
Source:
+
@@ -196,6 +201,11 @@ Always check noteId instead. +
Source:
+
+ @@ -258,6 +268,11 @@ Always check noteId instead. + +
Source:
+
@@ -311,6 +326,11 @@ Always check noteId instead. + +
Source:
+
@@ -374,6 +394,11 @@ Always check noteId instead. + +
Source:
+
@@ -435,6 +460,11 @@ of deletion should not act as a clone. + +
Source:
+
@@ -498,6 +528,11 @@ of deletion should not act as a clone. + +
Source:
+
@@ -561,6 +596,11 @@ of deletion should not act as a clone. + +
Source:
+
@@ -614,6 +654,11 @@ of deletion should not act as a clone. + +
Source:
+
@@ -677,6 +722,11 @@ of deletion should not act as a clone. + +
Source:
+
@@ -693,7 +743,7 @@ of deletion should not act as a clone. -

prefix :string

+

prefix :string|null

@@ -705,6 +755,9 @@ of deletion should not act as a clone.
  • string +| + +null
    • @@ -740,6 +793,11 @@ of deletion should not act as a clone. + +
    Source:
    +
    @@ -803,6 +861,11 @@ of deletion should not act as a clone. + +
    Source:
    +
    @@ -880,6 +943,11 @@ of deletion should not act as a clone. +
    Source:
    +
    + @@ -964,6 +1032,11 @@ of deletion should not act as a clone. +
    Source:
    +
    + @@ -1140,6 +1213,11 @@ of deletion should not act as a clone. + +
    Source:
    +
    @@ -1247,6 +1325,11 @@ of deletion should not act as a clone. +
    Source:
    +
    + @@ -1331,6 +1414,11 @@ of deletion should not act as a clone. +
    Source:
    +
    + @@ -1415,6 +1503,11 @@ of deletion should not act as a clone. +
    Source:
    +
    + @@ -1499,6 +1592,11 @@ of deletion should not act as a clone. +
    Source:
    +
    + @@ -1653,6 +1751,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' +
    Source:
    +
    + @@ -1741,6 +1844,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' +
    Source:
    +
    + @@ -1808,7 +1916,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
    diff --git a/docs/backend_api/BEtapiToken.html b/docs/backend_api/BEtapiToken.html index 3ef744252..1fab94869 100644 --- a/docs/backend_api/BEtapiToken.html +++ b/docs/backend_api/BEtapiToken.html @@ -96,6 +96,11 @@ from tokenHash and token. + +
    Source:
    +
    @@ -198,6 +203,11 @@ from tokenHash and token. +
    Source:
    +
    + @@ -260,6 +270,11 @@ from tokenHash and token. + +
    Source:
    +
    @@ -323,6 +338,11 @@ from tokenHash and token. + +
    Source:
    +
    @@ -386,6 +406,11 @@ from tokenHash and token. + +
    Source:
    +
    @@ -449,6 +474,11 @@ from tokenHash and token. + +
    Source:
    +
    @@ -512,6 +542,11 @@ from tokenHash and token. + +
    Source:
    +
    @@ -575,6 +610,11 @@ from tokenHash and token. + +
    Source:
    +
    @@ -652,6 +692,11 @@ from tokenHash and token. +
    Source:
    +
    + @@ -736,6 +781,11 @@ from tokenHash and token. +
    Source:
    +
    + @@ -820,6 +870,11 @@ from tokenHash and token. +
    Source:
    +
    + @@ -904,6 +959,11 @@ from tokenHash and token. +
    Source:
    +
    + @@ -988,6 +1048,11 @@ from tokenHash and token. +
    Source:
    +
    + @@ -1072,6 +1137,11 @@ from tokenHash and token. +
    Source:
    +
    + @@ -1226,6 +1296,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' +
    Source:
    +
    + @@ -1314,6 +1389,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' +
    Source:
    +
    + @@ -1381,7 +1461,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
    diff --git a/docs/backend_api/BNote.html b/docs/backend_api/BNote.html index 1ca80c827..d38f35c0f 100644 --- a/docs/backend_api/BNote.html +++ b/docs/backend_api/BNote.html @@ -90,6 +90,11 @@ + +
    Source:
    +
    @@ -192,6 +197,11 @@ +
    Source:
    +
    + @@ -254,6 +264,11 @@ + +
    Source:
    +
    @@ -317,6 +332,11 @@ + +
    Source:
    +
    @@ -383,6 +403,11 @@ + +
    Source:
    +
    @@ -450,6 +475,11 @@ + +
    Source:
    +
    @@ -513,6 +543,11 @@ + +
    Source:
    +
    @@ -576,6 +611,11 @@ + +
    Source:
    +
    @@ -639,6 +679,11 @@ + +
    Source:
    +
    @@ -702,6 +747,11 @@ + +
    Source:
    +
    @@ -765,6 +815,11 @@ + +
    Source:
    +
    @@ -828,6 +883,11 @@ + +
    Source:
    +
    @@ -891,6 +951,11 @@ + +
    Source:
    +
    @@ -954,6 +1019,11 @@ + +
    Source:
    +
    @@ -980,7 +1050,7 @@ -

    addAttribute(type, name, valueopt, isInheritableopt, positionopt) → {Attribute}

    +

    addAttribute(type, name, valueopt, isInheritableopt, positionopt) → {BAttribute}

    @@ -1245,6 +1315,11 @@ See addLabel, addRelation for more specific methods. + +
    Source:
    +
    @@ -1279,7 +1354,7 @@ See addLabel, addRelation for more specific methods.
    -Attribute +BAttribute
    @@ -1348,6 +1423,11 @@ See addLabel, addRelation for more specific methods. +
    Source:
    +
    + @@ -1381,7 +1461,7 @@ See addLabel, addRelation for more specific methods. -

    addLabel(name, valueopt, isInheritableopt) → {Attribute}

    +

    addLabel(name, valueopt, isInheritableopt) → {BAttribute}

    @@ -1571,6 +1651,11 @@ See addLabel, addRelation for more specific methods. + +
    Source:
    +
    @@ -1605,7 +1690,7 @@ See addLabel, addRelation for more specific methods.
    -Attribute +BAttribute
    @@ -1623,7 +1708,7 @@ See addLabel, addRelation for more specific methods. -

    addRelation(name, targetNoteId, isInheritableopt) → {Attribute}

    +

    addRelation(name, targetNoteId, isInheritableopt) → {BAttribute}

    @@ -1812,6 +1897,11 @@ returned. + +
    Source:
    +
    @@ -1846,7 +1936,7 @@ returned.
    -Attribute +BAttribute
    @@ -1915,6 +2005,11 @@ returned. +
    Source:
    +
    + @@ -2037,6 +2132,11 @@ returned. + +
    Source:
    +
    @@ -2232,6 +2332,11 @@ returned. + +
    Source:
    +
    @@ -2317,6 +2422,11 @@ returned. +
    Source:
    +
    + @@ -2401,6 +2511,11 @@ returned. +
    Source:
    +
    + @@ -2479,6 +2594,11 @@ returned. + +
    Source:
    +
    @@ -2580,6 +2700,11 @@ returned. + +
    Source:
    +
    @@ -2632,7 +2757,7 @@ returned. -

    getAttribute(type, name) → {Attribute}

    +

    getAttribute(type, name) → {BAttribute}

    @@ -2749,6 +2874,11 @@ returned. + +
    Source:
    +
    @@ -2787,7 +2917,7 @@ returned.
    -Attribute +BAttribute
    @@ -2922,6 +3052,11 @@ returned. + +
    Source:
    +
    @@ -2981,7 +3116,7 @@ returned. -

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

    +

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

    @@ -3120,6 +3255,11 @@ returned. + +
    Source:
    +
    @@ -3158,7 +3298,7 @@ returned.
    -Array.<Attribute> +Array.<BAttribute>
    @@ -3224,6 +3364,11 @@ returned. +
    Source:
    +
    + @@ -3320,6 +3465,11 @@ returned. + +
    Source:
    +
    @@ -3417,6 +3567,11 @@ returned. + +
    Source:
    +
    @@ -3514,6 +3669,11 @@ returned. + +
    Source:
    +
    @@ -3611,6 +3771,11 @@ returned. + +
    Source:
    +
    @@ -3711,6 +3876,11 @@ returned. +
    Source:
    +
    + @@ -3795,6 +3965,11 @@ returned. + +
    Source:
    +
    @@ -3851,6 +4026,113 @@ returned. +

    getInheritingNotes() → {Array.<BNote>}

    + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    Returns:
    + + +
    + - returns only notes which are templated, does not include their subtrees + in effect returns notes which are influenced by note's non-inheritable attributes +
    + + + +
    +
    + Type +
    +
    + +Array.<BNote> + + +
    +
    + + + + + + + + + + + + +

    getJsonContent() → {*}

    @@ -3896,6 +4178,11 @@ returned. + +
    Source:
    +
    @@ -3948,7 +4235,7 @@ returned. -

    getLabel(name) → {Attribute|null}

    +

    getLabel(name) → {BAttribute|null}

    @@ -4042,6 +4329,11 @@ returned. + +
    Source:
    +
    @@ -4080,7 +4372,7 @@ returned.
    -Attribute +BAttribute | null @@ -4195,6 +4487,11 @@ returned. + +
    Source:
    +
    @@ -4360,6 +4657,11 @@ returned. + +
    Source:
    +
    @@ -4416,7 +4718,7 @@ returned. -

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

    +

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

    @@ -4522,6 +4824,11 @@ returned. + +
    Source:
    +
    @@ -4560,7 +4867,7 @@ returned.
    -Array.<Attribute> +Array.<BAttribute>
    @@ -4578,7 +4885,7 @@ returned. -

    getOwnedAttribute() → {Attribute}

    +

    getNoteRevisions() → {Array.<BNoteRevision>}

    @@ -4623,6 +4930,113 @@ returned. + +
    Source:
    +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Returns:
    + + + + +
    +
    + Type +
    +
    + +Array.<BNoteRevision> + + +
    +
    + + + + + + + + + + + + + +

    getOwnedAttribute() → {BAttribute}

    + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    @@ -4663,7 +5077,7 @@ This method can be significantly faster than the getAttribute()
    -Attribute +BAttribute
    @@ -4798,6 +5212,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -4857,7 +5276,7 @@ This method can be significantly faster than the getAttribute() -

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

    +

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

    @@ -5058,6 +5477,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -5096,7 +5520,7 @@ This method can be significantly faster than the getAttribute()
    -Array.<Attribute> +Array.<BAttribute>
    @@ -5114,7 +5538,7 @@ This method can be significantly faster than the getAttribute() -

    getOwnedLabel(name) → {Attribute|null}

    +

    getOwnedLabel(name) → {BAttribute|null}

    @@ -5208,6 +5632,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -5246,7 +5675,7 @@ This method can be significantly faster than the getAttribute()
    -Attribute +BAttribute | null @@ -5361,6 +5790,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -5526,6 +5960,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -5582,7 +6021,7 @@ This method can be significantly faster than the getAttribute() -

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

    +

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

    @@ -5688,6 +6127,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -5726,7 +6170,7 @@ This method can be significantly faster than the getAttribute()
    -Array.<Attribute> +Array.<BAttribute>
    @@ -5744,7 +6188,7 @@ This method can be significantly faster than the getAttribute() -

    getOwnedRelation(name) → {Attribute|null}

    +

    getOwnedRelation(name) → {BAttribute|null}

    @@ -5838,6 +6282,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -5876,7 +6325,7 @@ This method can be significantly faster than the getAttribute()
    -Attribute +BAttribute | null @@ -5991,6 +6440,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -6050,7 +6504,7 @@ This method can be significantly faster than the getAttribute() -

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

    +

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

    @@ -6156,6 +6610,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -6194,7 +6653,7 @@ This method can be significantly faster than the getAttribute()
    -Array.<Attribute> +Array.<BAttribute>
    @@ -6257,6 +6716,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -6354,6 +6818,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -6457,6 +6926,11 @@ This method can be significantly faster than the getAttribute() +
    Source:
    +
    + @@ -6490,7 +6964,7 @@ This method can be significantly faster than the getAttribute() -

    getRelation(name) → {Attribute|null}

    +

    getRelation(name) → {BAttribute|null}

    @@ -6584,6 +7058,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -6622,7 +7101,7 @@ This method can be significantly faster than the getAttribute()
    -Attribute +BAttribute | null @@ -6737,6 +7216,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -6796,7 +7280,7 @@ This method can be significantly faster than the getAttribute() -

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

    +

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

    @@ -6902,6 +7386,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -6940,7 +7429,7 @@ This method can be significantly faster than the getAttribute()
    -Array.<Attribute> +Array.<BAttribute>
    @@ -7003,6 +7492,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -7107,6 +7601,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -7208,6 +7707,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -7305,6 +7809,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -7402,6 +7911,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -7504,102 +8018,10 @@ This method can be significantly faster than the getAttribute() - - - - - - -
    - - - - - - - - - - - - - - - -
    Returns:
    - - - - -
    -
    - Type -
    -
    - -Array.<BNote> - - -
    -
    - - - - - - - - - - - - - -

    getTemplatedNotes() → {Array.<BNote>}

    - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - +
    Source:
    +
    @@ -7626,11 +8048,6 @@ This method can be significantly faster than the getAttribute()
    Returns:
    -
    - - returns only notes which are templated, does not include their subtrees - in effect returns notes which are influenced by note's non-inheritable attributes -
    -
    @@ -7708,6 +8125,11 @@ This method can be significantly faster than the getAttribute() +
    Source:
    +
    + @@ -7786,6 +8208,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -8007,6 +8434,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -8104,6 +8536,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -8293,6 +8730,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -8517,6 +8959,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -8710,6 +9157,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -8903,6 +9355,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -9096,6 +9553,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -9241,6 +9703,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -9297,6 +9764,100 @@ This method can be significantly faster than the getAttribute() +

    isHiddenCompletely()

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

    isHtml() → {boolean}

    @@ -9342,6 +9903,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -9398,6 +9964,112 @@ This method can be significantly faster than the getAttribute() +

    isImage() → {boolean}

    + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    Returns:
    + + +
    + true if this note is an image +
    + + + +
    +
    + Type +
    +
    + +boolean + + +
    +
    + + + + + + + + + + + + +

    isJavaScript() → {boolean}

    @@ -9443,6 +10115,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -9544,6 +10221,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -9645,6 +10327,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -9746,6 +10433,11 @@ This method can be significantly faster than the getAttribute() + +
    Source:
    +
    @@ -9923,6 +10615,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' +
    Source:
    +
    + @@ -10128,6 +10825,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' + +
    Source:
    +
    @@ -10303,6 +11005,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' + +
    Source:
    +
    @@ -10478,6 +11185,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' + +
    Source:
    +
    @@ -10567,6 +11279,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' +
    Source:
    +
    + @@ -10663,6 +11380,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' + +
    Source:
    +
    @@ -10890,6 +11612,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' + +
    Source:
    +
    @@ -11065,6 +11792,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' + +
    Source:
    +
    @@ -11220,6 +11952,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' + +
    Source:
    +
    @@ -11457,6 +12194,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' + +
    Source:
    +
    @@ -11663,6 +12405,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' + +
    Source:
    +
    @@ -11869,6 +12616,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' + +
    Source:
    +
    @@ -11919,7 +12671,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
    diff --git a/docs/backend_api/BNoteRevision.html b/docs/backend_api/BNoteRevision.html index 5b9b4b336..0951fa14d 100644 --- a/docs/backend_api/BNoteRevision.html +++ b/docs/backend_api/BNoteRevision.html @@ -91,6 +91,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -193,6 +198,11 @@ It's used for seamless note versioning. +
    Source:
    +
    + @@ -255,6 +265,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -318,6 +333,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -381,6 +401,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -444,6 +469,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -507,6 +537,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -570,6 +605,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -633,6 +673,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -696,6 +741,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -759,6 +809,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -822,6 +877,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -885,6 +945,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -948,6 +1013,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -1025,6 +1095,11 @@ It's used for seamless note versioning. +
    Source:
    +
    + @@ -1109,6 +1184,11 @@ It's used for seamless note versioning. +
    Source:
    +
    + @@ -1193,6 +1273,11 @@ It's used for seamless note versioning. +
    Source:
    +
    + @@ -1277,6 +1362,11 @@ It's used for seamless note versioning. +
    Source:
    +
    + @@ -1355,6 +1445,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -1452,6 +1547,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -1555,6 +1655,11 @@ It's used for seamless note versioning. +
    Source:
    +
    + @@ -1639,6 +1744,11 @@ It's used for seamless note versioning. +
    Source:
    +
    + @@ -1717,6 +1827,11 @@ It's used for seamless note versioning. + +
    Source:
    +
    @@ -1894,6 +2009,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' +
    Source:
    +
    + @@ -1982,6 +2102,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' +
    Source:
    +
    + @@ -2049,7 +2174,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
    diff --git a/docs/backend_api/BOption.html b/docs/backend_api/BOption.html index d99af8540..b5990cb92 100644 --- a/docs/backend_api/BOption.html +++ b/docs/backend_api/BOption.html @@ -90,6 +90,11 @@ + +
    Source:
    +
    @@ -192,6 +197,11 @@ +
    Source:
    +
    + @@ -254,6 +264,11 @@ + +
    Source:
    +
    @@ -317,6 +332,11 @@ + +
    Source:
    +
    @@ -380,6 +400,11 @@ + +
    Source:
    +
    @@ -443,6 +468,11 @@ + +
    Source:
    +
    @@ -520,6 +550,11 @@ +
    Source:
    +
    + @@ -604,6 +639,11 @@ +
    Source:
    +
    + @@ -688,6 +728,11 @@ +
    Source:
    +
    + @@ -772,6 +817,11 @@ +
    Source:
    +
    + @@ -856,6 +906,11 @@ +
    Source:
    +
    + @@ -940,6 +995,11 @@ +
    Source:
    +
    + @@ -1094,6 +1154,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' +
    Source:
    +
    + @@ -1182,6 +1247,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' +
    Source:
    +
    + @@ -1249,7 +1319,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
    diff --git a/docs/backend_api/BRecentNote.html b/docs/backend_api/BRecentNote.html index 33f9799e9..b36b38298 100644 --- a/docs/backend_api/BRecentNote.html +++ b/docs/backend_api/BRecentNote.html @@ -90,6 +90,11 @@ + +
    Source:
    +
    @@ -192,6 +197,11 @@ +
    Source:
    +
    + @@ -254,6 +264,11 @@ + +
    Source:
    +
    @@ -317,6 +332,11 @@ + +
    Source:
    +
    @@ -380,6 +400,11 @@ + +
    Source:
    +
    @@ -457,6 +482,11 @@ +
    Source:
    +
    + @@ -541,6 +571,11 @@ +
    Source:
    +
    + @@ -625,6 +660,11 @@ +
    Source:
    +
    + @@ -709,6 +749,11 @@ +
    Source:
    +
    + @@ -793,6 +838,11 @@ +
    Source:
    +
    + @@ -877,6 +927,11 @@ +
    Source:
    +
    + @@ -1031,6 +1086,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' +
    Source:
    +
    + @@ -1119,6 +1179,11 @@ This is a low level method, for notes and branches use `note.deleteNote()` and ' +
    Source:
    +
    + @@ -1186,7 +1251,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
    diff --git a/docs/backend_api/BackendScriptApi.html b/docs/backend_api/BackendScriptApi.html index 2f5a312c3..12800f161 100644 --- a/docs/backend_api/BackendScriptApi.html +++ b/docs/backend_api/BackendScriptApi.html @@ -28,7 +28,7 @@
    -

    BackendScriptApi

    +

    BackendScriptApi()

    @@ -38,7 +38,20 @@ + + +

    new BackendScriptApi()

    + + + + + + +
    +

    This is the main backend API interface for scripts. All the properties and methods are published in the "api" object +available in the JS backend notes. You can use e.g. api.log(api.startNote.title);

    +
    @@ -78,6 +91,11 @@ + +
    Source:
    +
    @@ -219,6 +237,11 @@ + +
    Source:
    +
    @@ -288,7 +311,7 @@ - library for HTTP requests. See https://axios-http.com/ for documentation + library for HTTP requests. See https://axios-http.com for documentation @@ -315,7 +338,7 @@ - +
    Deprecated:
    • use native (browser compatible) fetch() instead
    @@ -327,6 +350,13 @@ +
    Source:
    +
    + + + @@ -429,6 +459,11 @@ + +
    Source:
    +
    @@ -498,7 +533,7 @@ - library for date manipulation. See https://day.js.org/ for documentation + library for date manipulation. See https://day.js.org for documentation @@ -534,6 +569,11 @@ + +
    Source:
    +
    @@ -593,7 +633,7 @@ -Entity +AbstractBeccaEntity @@ -639,6 +679,11 @@ + +
    Source:
    +
    @@ -744,6 +789,11 @@ + +
    Source:
    +
    @@ -849,6 +899,11 @@ + +
    Source:
    +
    @@ -918,7 +973,7 @@ - library for XML parsing. See https://github.com/Leonidas-from-XIV/node-xml2js for documentation + library for XML parsing. See https://github.com/Leonidas-from-XIV/node-xml2js for documentation @@ -954,6 +1009,11 @@ + +
    Source:
    +
    @@ -1125,6 +1185,11 @@ JSON MIME type. See also createNewNote() for more options. + +
    Source:
    +
    @@ -1623,6 +1688,11 @@ JSON MIME type. See also createNewNote() for more options. + +
    Source:
    +
    @@ -2239,6 +2309,11 @@ JSON MIME type. See also createNewNote() for more options. +
    Source:
    +
    + @@ -2739,6 +2814,11 @@ JSON MIME type. See also createNewNote() for more options. + +
    Source:
    +
    @@ -2935,6 +3015,11 @@ JSON MIME type. See also createNewNote() for more options. + +
    Source:
    +
    @@ -3112,6 +3197,11 @@ JSON MIME type. See also createNewNote() for more options. + +
    Source:
    +
    @@ -3308,6 +3398,11 @@ JSON MIME type. See also createNewNote() for more options. + +
    Source:
    +
    @@ -3454,6 +3549,11 @@ JSON MIME type. See also createNewNote() for more options. + +
    Source:
    +
    @@ -3510,7 +3610,7 @@ JSON MIME type. See also createNewNote() for more options. -

    exportSubtreeToZipFile(noteId, format, zipFilePath) → {Promise}

    +

    exportSubtreeToZipFile(noteId, format, zipFilePath) → {Promise.<void>}

    @@ -3650,6 +3750,11 @@ JSON MIME type. See also createNewNote() for more options. + +
    Source:
    +
    @@ -3684,7 +3789,7 @@ JSON MIME type. See also createNewNote() for more options.
    -Promise +Promise.<void>
    @@ -3747,6 +3852,11 @@ JSON MIME type. See also createNewNote() for more options. + +
    Source:
    +
    @@ -3806,7 +3916,7 @@ JSON MIME type. See also createNewNote() for more options. -

    getAttribute(attributeId) → {Attribute|null}

    +

    getAttribute(attributeId) → {BAttribute|null}

    @@ -3900,6 +4010,11 @@ JSON MIME type. See also createNewNote() for more options. + +
    Source:
    +
    @@ -3934,7 +4049,7 @@ JSON MIME type. See also createNewNote() for more options.
    -Attribute +BAttribute | null @@ -4049,6 +4164,11 @@ JSON MIME type. See also createNewNote() for more options. + +
    Source:
    +
    @@ -4104,204 +4224,6 @@ JSON MIME type. See also createNewNote() for more options. -

    getDateNote(date, rootNoteopt) → {BNote|null}

    - - - - - - -
    - Returns day note for given date. If such note doesn't exist, it is created. -
    - - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeAttributesDescription
    date - - -string - - - - - - - - - - in YYYY-MM-DD format
    rootNote - - -BNote - - - - - - <optional>
    - - - - - -     		specify calendar root note, normally leave empty to use default calendar
    - - - - - - -
    - - - - - - - - - - - - - - - - -
    Deprecated:
    • use getDayNote instead
    - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - -
    Returns:
    - - - - -
    -
    - Type -
    -
    - -BNote -| - -null - - -
    -
    - - - - - - - - - - - - -

    getDayNote(date, rootNoteopt) → {BNote|null}

    @@ -4405,7 +4327,7 @@ JSON MIME type. See also createNewNote() for more options. - specify calendar root note, normally leave empty to use default calendar + specify calendar root note, normally leave empty to use the default calendar @@ -4443,6 +4365,11 @@ JSON MIME type. See also createNewNote() for more options. + +
    Source:
    +
    @@ -4548,6 +4475,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -4706,7 +4638,7 @@ if some action needs to happen on only one specific instance. - specify calendar root note, normally leave empty to use default calendar + specify calendar root note, normally leave empty to use the default calendar @@ -4744,6 +4676,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -4893,6 +4830,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -5089,6 +5031,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -5285,6 +5232,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -5386,6 +5338,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -5513,7 +5470,7 @@ if some action needs to happen on only one specific instance. - specify calendar root note, normally leave empty to use default calendar + specify calendar root note, normally leave empty to use the default calendar @@ -5551,6 +5508,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -5709,7 +5671,76 @@ if some action needs to happen on only one specific instance. - "startOfTheWeek" - either "monday" (default) or "sunday" + +
    Properties
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeAttributesDefaultDescription
    startOfTheWeek + + +string + + + + + + <optional>
    + + + + + +     		+ + monday + + either "monday" (default) or "sunday"
    + + @@ -5742,7 +5773,7 @@ if some action needs to happen on only one specific instance. - specify calendar root note, normally leave empty to use default calendar + specify calendar root note, normally leave empty to use the default calendar @@ -5780,6 +5811,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -5938,7 +5974,7 @@ if some action needs to happen on only one specific instance. - specify calendar root note, normally leave empty to use default calendar + specify calendar root note, normally leave empty to use the default calendar @@ -5976,6 +6012,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -6031,7 +6072,7 @@ if some action needs to happen on only one specific instance. -

    log(message)

    +

    log(message) → {void}

    @@ -6124,6 +6165,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -6147,6 +6193,24 @@ if some action needs to happen on only one specific instance. +
    Returns:
    + + + + +
    +
    + Type +
    +
    + +void + + +
    +
    + + @@ -6256,6 +6320,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -6306,87 +6375,6 @@ if some action needs to happen on only one specific instance. - - - - - - -

    refreshTree()

    - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - -
    Deprecated:
    • - this is now no-op since all the changes should be gracefully handled per widget
    - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - @@ -6402,7 +6390,7 @@ if some action needs to happen on only one specific instance.
    This is a powerful search method - you can search by attributes and their values, e.g.: -"#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search +"#dateModified =* MONTH AND #log". See https://github.com/zadam/trilium/wiki/Search for full documentation for all options
    @@ -6535,6 +6523,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -6599,7 +6592,7 @@ if some action needs to happen on only one specific instance.
    This is a powerful search method - you can search by attributes and their values, e.g.: -"#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search +"#dateModified =* MONTH AND #log". See https://github.com/zadam/trilium/wiki/Search for full documentation for all options
    @@ -6732,6 +6725,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -6784,7 +6782,7 @@ if some action needs to happen on only one specific instance. -

    setNoteToParent(noteId, prefix, parentNoteId)

    +

    setNoteToParent(noteId, prefix, parentNoteId) → {void}

    @@ -6925,7 +6923,7 @@ This method looks similar to toggleNoteInParent() but differs because we're look -
    Deprecated:
    • - this method is pretty confusing and serves specialized purpose only
    +
    Deprecated:
    • this method is pretty confusing and serves specialized purpose only
    @@ -6937,6 +6935,11 @@ This method looks similar to toggleNoteInParent() but differs because we're look +
    Source:
    +
    + @@ -6959,6 +6962,24 @@ This method looks similar to toggleNoteInParent() but differs because we're look +
    Returns:
    + + + + +
    +
    + Type +
    +
    + +void + + +
    +
    + + @@ -6970,7 +6991,7 @@ This method looks similar to toggleNoteInParent() but differs because we're look -

    sortNotes(parentNoteId, sortConfigopt)

    +

    sortNotes(parentNoteId, sortConfigopt) → {void}

    @@ -7146,7 +7167,7 @@ This method looks similar to toggleNoteInParent() but differs because we're look 'title', 'dateCreated', 'dateModified' or a label name - see https://github.com/zadam/trilium/wiki/Sorting for details. + See https://github.com/zadam/trilium/wiki/Sorting for details. @@ -7257,135 +7278,10 @@ This method looks similar to toggleNoteInParent() but differs because we're look - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -

    sortNotesByTitle(parentNoteId)

    - - - - - - - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    parentNoteId - - -string - - - - this note's child notes will be sorted
    - - - - - - -
    - - - - - - - - - - - - - - - - -
    Deprecated:
    • - use sortNotes instead
    - - - - - - - - - - +
    Source:
    +
    @@ -7409,6 +7305,24 @@ This method looks similar to toggleNoteInParent() but differs because we're look +
    Returns:
    + + + + +
    +
    + Type +
    +
    + +void + + +
    +
    + + @@ -7587,6 +7501,11 @@ This method looks similar to toggleNoteInParent() but differs because we're look + +
    Source:
    +
    @@ -7738,6 +7657,11 @@ exists, then we'll use that transaction. + +
    Source:
    +
    @@ -7888,6 +7812,11 @@ exists, then we'll use that transaction. + +
    Source:
    +
    @@ -7960,7 +7889,7 @@ exists, then we'll use that transaction.
    diff --git a/docs/backend_api/index.html b/docs/backend_api/index.html index 455fa5fdc..55d778a7e 100644 --- a/docs/backend_api/index.html +++ b/docs/backend_api/index.html @@ -56,7 +56,7 @@
    diff --git a/docs/backend_api/module-sql.html b/docs/backend_api/module-sql.html index 73bde2df5..6517bc0d4 100644 --- a/docs/backend_api/module-sql.html +++ b/docs/backend_api/module-sql.html @@ -64,6 +64,11 @@ + +
    Source:
    +
    @@ -242,6 +247,11 @@ + +
    Source:
    +
    @@ -417,6 +427,11 @@ + +
    Source:
    +
    @@ -614,6 +629,11 @@ + +
    Source:
    +
    @@ -811,6 +831,11 @@ + +
    Source:
    +
    @@ -1008,6 +1033,11 @@ + +
    Source:
    +
    @@ -1205,6 +1235,11 @@ + +
    Source:
    +
    @@ -1265,7 +1300,7 @@
    diff --git a/docs/frontend_api/FAttribute.html b/docs/frontend_api/FAttribute.html index 19721bc55..641c3a737 100644 --- a/docs/frontend_api/FAttribute.html +++ b/docs/frontend_api/FAttribute.html @@ -91,6 +91,11 @@ and relation (representing named relationship between source and target note)Source: +
    @@ -186,6 +191,11 @@ and relation (representing named relationship between source and target note)Source: +
    @@ -249,6 +259,11 @@ and relation (representing named relationship between source and target note)Source: +
    @@ -312,6 +327,11 @@ and relation (representing named relationship between source and target note)Source: +
    @@ -375,6 +395,11 @@ and relation (representing named relationship between source and target note)Source: +
    @@ -438,6 +463,11 @@ and relation (representing named relationship between source and target note)Source: +
    @@ -501,6 +531,11 @@ and relation (representing named relationship between source and target note)Source: +
    @@ -564,6 +599,11 @@ and relation (representing named relationship between source and target note)Source: +
    @@ -635,6 +675,11 @@ and relation (representing named relationship between source and target note)Source: +
    @@ -732,6 +777,11 @@ and relation (representing named relationship between source and target note)Source: +
    @@ -800,7 +850,7 @@ and relation (representing named relationship between source and target note) diff --git a/docs/frontend_api/FBranch.html b/docs/frontend_api/FBranch.html index 07792adcb..284bc72d5 100644 --- a/docs/frontend_api/FBranch.html +++ b/docs/frontend_api/FBranch.html @@ -91,6 +91,11 @@ parents. + +
    Source:
    +
    @@ -190,6 +195,11 @@ parents. + +
    Source:
    +
    @@ -253,6 +263,11 @@ parents. + +
    Source:
    +
    @@ -316,6 +331,11 @@ parents. + +
    Source:
    +
    @@ -379,6 +399,11 @@ parents. + +
    Source:
    +
    @@ -442,6 +467,11 @@ parents. + +
    Source:
    +
    @@ -505,6 +535,11 @@ parents. + +
    Source:
    +
    @@ -568,6 +603,11 @@ parents. + +
    Source:
    +
    @@ -639,6 +679,11 @@ parents. + +
    Source:
    +
    @@ -736,6 +781,11 @@ parents. + +
    Source:
    +
    @@ -833,6 +883,11 @@ parents. + +
    Source:
    +
    @@ -930,6 +985,11 @@ parents. + +
    Source:
    +
    @@ -1002,7 +1062,7 @@ parents.
    diff --git a/docs/frontend_api/FNote.html b/docs/frontend_api/FNote.html index a3afeef6e..cff8d1e8f 100644 --- a/docs/frontend_api/FNote.html +++ b/docs/frontend_api/FNote.html @@ -158,6 +158,11 @@ + +
    Source:
    +
    @@ -253,6 +258,11 @@ + +
    Source:
    +
    @@ -316,6 +326,11 @@ + +
    Source:
    +
    @@ -379,6 +394,11 @@ + +
    Source:
    +
    @@ -442,6 +462,11 @@ + +
    Source:
    +
    @@ -509,6 +534,11 @@ + +
    Source:
    +
    @@ -572,6 +602,11 @@ + +
    Source:
    +
    @@ -635,6 +670,11 @@ + +
    Source:
    +
    @@ -698,6 +738,11 @@ + +
    Source:
    +
    @@ -761,6 +806,11 @@ + +
    Source:
    +
    @@ -824,6 +874,11 @@ + +
    Source:
    +
    @@ -891,6 +946,11 @@ + +
    Source:
    +
    @@ -1034,6 +1094,11 @@ + +
    Source:
    +
    @@ -1207,6 +1272,11 @@ + +
    Source:
    +
    @@ -1402,6 +1472,11 @@ + +
    Source:
    +
    @@ -1506,6 +1581,11 @@ +
    Source:
    +
    + @@ -1605,6 +1685,11 @@ +
    Source:
    +
    + @@ -1701,6 +1786,11 @@ + +
    Source:
    +
    @@ -1798,6 +1888,11 @@ + +
    Source:
    +
    @@ -1895,6 +1990,11 @@ + +
    Source:
    +
    @@ -2041,6 +2141,11 @@ + +
    Source:
    +
    @@ -2191,6 +2296,11 @@ + +
    Source:
    +
    @@ -2353,6 +2463,11 @@ + +
    Source:
    +
    @@ -2458,6 +2573,11 @@ + +
    Source:
    +
    @@ -2510,6 +2630,108 @@ +

    getNotesToInheritAttributesFrom() → {Array.<FNote>}

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

    getOwnedAttribute(type, name) → {FAttribute}

    @@ -2627,6 +2849,11 @@ + +
    Source:
    +
    @@ -2800,6 +3027,11 @@ + +
    Source:
    +
    @@ -2995,6 +3227,11 @@ + +
    Source:
    +
    @@ -3145,6 +3382,11 @@ + +
    Source:
    +
    @@ -3295,6 +3537,11 @@ + +
    Source:
    +
    @@ -3457,6 +3704,11 @@ + +
    Source:
    +
    @@ -3607,6 +3859,11 @@ + +
    Source:
    +
    @@ -3757,6 +4014,11 @@ + +
    Source:
    +
    @@ -3919,6 +4181,11 @@ + +
    Source:
    +
    @@ -4020,6 +4287,11 @@ + +
    Source:
    +
    @@ -4117,6 +4389,11 @@ + +
    Source:
    +
    @@ -4214,6 +4491,11 @@ + +
    Source:
    +
    @@ -4311,6 +4593,11 @@ + +
    Source:
    +
    @@ -4457,6 +4744,11 @@ + +
    Source:
    +
    @@ -4607,6 +4899,11 @@ + +
    Source:
    +
    @@ -4772,6 +5069,11 @@ + +
    Source:
    +
    @@ -4918,6 +5220,11 @@ + +
    Source:
    +
    @@ -5080,6 +5387,11 @@ + +
    Source:
    +
    @@ -5181,6 +5493,11 @@ + +
    Source:
    +
    @@ -5289,6 +5606,11 @@ + +
    Source:
    +
    @@ -5390,6 +5712,11 @@ + +
    Source:
    +
    @@ -5442,103 +5769,6 @@ -

    getTemplateNotes() → {Array.<FNote>}

    - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - -
    Returns:
    - - - - -
    -
    - Type -
    -
    - -Array.<FNote> - - -
    -
    - - - - - - - - - - - - -

    hasAttribute(type, name) → {boolean}

    @@ -5656,6 +5886,11 @@ + +
    Source:
    +
    @@ -5757,6 +5992,11 @@ + +
    Source:
    +
    @@ -5903,6 +6143,11 @@ + +
    Source:
    +
    @@ -6076,6 +6321,11 @@ + +
    Source:
    +
    @@ -6226,6 +6476,11 @@ + +
    Source:
    +
    @@ -6376,6 +6631,11 @@ + +
    Source:
    +
    @@ -6526,6 +6786,11 @@ + +
    Source:
    +
    @@ -6630,6 +6895,11 @@ +
    Source:
    +
    + @@ -6657,6 +6927,100 @@ + + + + + + +

    isHiddenCompletely()

    + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    Returns:
    + + +
    + boolean - true if there's no non-hidden path, note is not cloned to the visible tree +
    + + + + + + + + + @@ -6708,6 +7072,11 @@ + +
    Source:
    +
    @@ -6809,6 +7178,11 @@ + +
    Source:
    +
    @@ -6836,7 +7210,7 @@
    - true if this note is JavaScript (code or attachment) + true if this note is JavaScript (code or file)
    @@ -6910,6 +7284,11 @@ + +
    Source:
    +
    @@ -6978,7 +7357,7 @@
    diff --git a/docs/frontend_api/FNoteComplement.html b/docs/frontend_api/FNoteComplement.html index 121ffd256..8c1bb3d94 100644 --- a/docs/frontend_api/FNoteComplement.html +++ b/docs/frontend_api/FNoteComplement.html @@ -90,6 +90,11 @@ + +
    Source:
    +
    @@ -185,6 +190,11 @@ + +
    Source:
    +
    @@ -248,6 +258,11 @@ + +
    Source:
    +
    @@ -315,6 +330,11 @@ + +
    Source:
    +
    @@ -378,6 +398,11 @@ + +
    Source:
    +
    @@ -441,6 +466,11 @@ + +
    Source:
    +
    @@ -504,6 +534,11 @@ + +
    Source:
    +
    @@ -567,6 +602,11 @@ + +
    Source:
    +
    @@ -630,6 +670,11 @@ + +
    Source:
    +
    @@ -693,6 +738,11 @@ + +
    Source:
    +
    @@ -731,7 +781,7 @@
    diff --git a/docs/frontend_api/FrontendScriptApi.html b/docs/frontend_api/FrontendScriptApi.html index 2e5667bca..e866a8473 100644 --- a/docs/frontend_api/FrontendScriptApi.html +++ b/docs/frontend_api/FrontendScriptApi.html @@ -28,7 +28,7 @@
    -

    FrontendScriptApi

    +

    FrontendScriptApi()

    @@ -38,7 +38,20 @@ + + +

    new FrontendScriptApi()

    + + + + + + +
    +

    This is the main frontend API interface for scripts. All the properties and methods are published in the "api" object +available in the JS frontend notes. You can use e.g. api.showMessage(api.startNote.title);

    +
    @@ -78,6 +91,11 @@ + +
    Source:
    +
    @@ -215,6 +233,11 @@ + +
    Source:
    +
    @@ -316,6 +339,11 @@ + +
    Source:
    +
    @@ -420,6 +448,11 @@ +
    Source:
    +
    + @@ -520,6 +553,11 @@ + +
    Source:
    +
    @@ -624,6 +662,11 @@ +
    Source:
    +
    + @@ -724,6 +767,11 @@ + +
    Source:
    +
    @@ -828,6 +876,11 @@ +
    Source:
    +
    + @@ -931,6 +984,11 @@ +
    Source:
    +
    + @@ -1035,6 +1093,121 @@ + +
    Source:
    +
    + + + + + + + +
    + + + + + + + + +

    dayjs

    + + + + + + + + + + +
    Properties:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    day.js + + +dayjs + + + + library for date manipulation. See https://day.js.org for documentation
    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    @@ -1143,6 +1316,11 @@ + +
    Source:
    +
    @@ -1248,6 +1426,11 @@ + +
    Source:
    +
    @@ -1372,6 +1555,11 @@ + +
    Source:
    +
    @@ -1522,6 +1710,11 @@ + +
    Source:
    +
    @@ -1859,6 +2052,11 @@ +
    Source:
    +
    + @@ -1991,139 +2189,10 @@ - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -

    addTextToActiveTabEditor(text)

    - - - - - - -
    - Adds given text to the editor cursor -
    - - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    text - - -string - - - - this must be clear text, HTML is not supported.
    - - - - - - -
    - - - - - - - - - - - - - - - - -
    Deprecated:
    • use addTextToActiveContextEditor() instead
    - - - - - - - - - - +
    Source:
    +
    @@ -2158,7 +2227,7 @@ -

    bindGlobalShortcut(keyboardShortcut, handler, namespaceopt)

    +

    bindGlobalShortcut(keyboardShortcut, handler, namespaceopt) → {Promise.<void>}

    @@ -2327,6 +2396,11 @@ + +
    Source:
    +
    @@ -2350,6 +2424,24 @@ +
    Returns:
    + + + + +
    +
    + Type +
    +
    + +Promise.<void> + + +
    +
    + + @@ -2686,6 +2778,11 @@ + +
    Source:
    +
    @@ -2814,6 +2911,11 @@ + +
    Source:
    +
    @@ -2919,6 +3021,11 @@ + +
    Source:
    +
    @@ -3020,6 +3127,11 @@ + +
    Source:
    +
    @@ -3121,6 +3233,11 @@ + +
    Source:
    +
    @@ -3226,6 +3343,11 @@ + +
    Source:
    +
    @@ -3332,6 +3454,11 @@ implementation of actual widget type. + +
    Source:
    +
    @@ -3378,353 +3505,6 @@ implementation of actual widget type. - - - - - - -

    getActiveTabNote() → {FNote}

    - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - -
    Deprecated:
    • use getActiveContextNote() instead
    - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - -
    Returns:
    - - -
    - active note (loaded into right pane) -
    - - - -
    -
    - Type -
    -
    - -FNote - - -
    -
    - - - - - - - - - - - - - -

    getActiveTabNotePath() → {Promise.<(string|null)>}

    - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - -
    Deprecated:
    • use getActiveContextNotePath() instead
    - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - -
    Returns:
    - - -
    - returns note path of active note or null if there isn't active note -
    - - - -
    -
    - Type -
    -
    - -Promise.<(string|null)> - - -
    -
    - - - - - - - - - - - - - -

    getActiveTabTextEditor(callbackopt)

    - - - - - - -
    - See https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editor-Editor.html for a documentation on the returned instance. -
    - - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeAttributesDescription
    callback - - - - <optional>
    - - - - - -     		callback receiving "textEditor" instance
    - - - - - - -
    - - - - - - - - - - - - - - - - -
    Deprecated:
    • use getActiveContextTextEditor()
    - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - @@ -3829,6 +3609,11 @@ implementation of actual widget type. + +
    Source:
    +
    @@ -3881,158 +3666,6 @@ implementation of actual widget type. -

    getDateNote(date) → {Promise.<FNote>}

    - - - - - - -
    - Returns day note for a given date. If it doesn't exist, it is automatically created. -
    - - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    date - - -string - - - - e.g. "2019-04-29"
    - - - - - - -
    - - - - - - - - - - - - - - - - -
    Deprecated:
    • use getDayNote instead
    - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - -
    Returns:
    - - - - -
    -
    - Type -
    -
    - -Promise.<FNote> - - -
    -
    - - - - - - - - - - - - -

    getDayNote(date) → {Promise.<FNote>}

    @@ -4131,6 +3764,11 @@ implementation of actual widget type. + +
    Source:
    +
    @@ -4233,6 +3871,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -4383,6 +4026,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -4534,6 +4182,11 @@ if some action needs to happen on only one specific instance. + +
    Source:
    +
    @@ -4730,6 +4383,11 @@ otherwise (by e.g. createNoteLink()) + +
    Source:
    +
    @@ -4831,6 +4489,11 @@ otherwise (by e.g. createNoteLink()) + +
    Source:
    +
    @@ -4981,6 +4644,11 @@ otherwise (by e.g. createNoteLink()) + +
    Source:
    +
    @@ -5131,6 +4799,11 @@ otherwise (by e.g. createNoteLink()) + +
    Source:
    +
    @@ -5183,7 +4856,7 @@ otherwise (by e.g. createNoteLink()) -

    log(message)

    +

    log(message) → {void}

    @@ -5276,6 +4949,11 @@ otherwise (by e.g. createNoteLink()) + +
    Source:
    +
    @@ -5299,6 +4977,24 @@ otherwise (by e.g. createNoteLink()) +
    Returns:
    + + + + +
    +
    + Type +
    +
    + +void + + +
    +
    + + @@ -5431,6 +5127,11 @@ otherwise (by e.g. createNoteLink()) + +
    Source:
    +
    @@ -5604,6 +5305,11 @@ otherwise (by e.g. createNoteLink()) + +
    Source:
    +
    @@ -5750,6 +5456,11 @@ otherwise (by e.g. createNoteLink()) + +
    Source:
    +
    @@ -5806,88 +5517,7 @@ otherwise (by e.g. createNoteLink()) -

    protectActiveNote()

    - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - -
    Deprecated:
    • use protectNote and protectSubtree instead
    - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -

    protectNote(noteId, protect)

    +

    protectNote(noteId, protect) → {Promise.<void>}

    @@ -6004,6 +5634,11 @@ otherwise (by e.g. createNoteLink()) + +
    Source:
    +
    @@ -6027,6 +5662,24 @@ otherwise (by e.g. createNoteLink()) +
    Returns:
    + + + + +
    +
    + Type +
    +
    + +Promise.<void> + + +
    +
    + + @@ -6038,7 +5691,7 @@ otherwise (by e.g. createNoteLink()) -

    protectSubTree(noteId, protect)

    +

    protectSubTree(noteId, protect) → {Promise.<void>}

    @@ -6155,6 +5808,11 @@ otherwise (by e.g. createNoteLink()) + +
    Source:
    +
    @@ -6178,6 +5836,24 @@ otherwise (by e.g. createNoteLink()) +
    Returns:
    + + + + +
    +
    + Type +
    +
    + +Promise.<void> + + +
    +
    + + @@ -6287,6 +5963,11 @@ otherwise (by e.g. createNoteLink()) + +
    Source:
    +
    @@ -6343,7 +6024,7 @@ otherwise (by e.g. createNoteLink()) -

    refreshIncludedNote(includedNoteId)

    +

    refreshIncludedNote(includedNoteId) → {Promise.<void>}

    @@ -6436,6 +6117,11 @@ otherwise (by e.g. createNoteLink()) + +
    Source:
    +
    @@ -6459,87 +6145,24 @@ otherwise (by e.g. createNoteLink()) - - - - +
    Returns:
    - - - - - -

    refreshTree()

    - - - +
    +
    + Type +
    +
    + +Promise.<void> - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - -
    Deprecated:
    • - this is now no-op since all the changes should be gracefully handled per widget
    - - - - - - - - - - - - - - - - - +
    - - - - - - - - - - - - - - + @@ -6649,6 +6272,11 @@ otherwise (by e.g. createNoteLink()) + +
    Source:
    +
    @@ -6767,7 +6395,7 @@ Internally this serializes the anonymous function into string and sends it to ba - list of parameters to the anonymous function to be send to backend + list of parameters to the anonymous function to be sent to backend @@ -6805,6 +6433,11 @@ Internally this serializes the anonymous function into string and sends it to ba + +
    Source:
    +
    @@ -6855,87 +6488,6 @@ Internally this serializes the anonymous function into string and sends it to ba - - - - - - -

    runOnServer()

    - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - -
    Deprecated:
    • new name of this API call is runOnBackend so use that
    - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - @@ -7041,6 +6593,11 @@ Internally this serializes the anonymous function into string and sends it to ba + +
    Source:
    +
    @@ -7192,6 +6749,11 @@ Internally this serializes the anonymous function into string and sends it to ba + +
    Source:
    +
    @@ -7244,7 +6806,7 @@ Internally this serializes the anonymous function into string and sends it to ba -

    setHoistedNoteId(noteId) → {Promise}

    +

    setHoistedNoteId(noteId) → {Promise.<void>}

    @@ -7342,6 +6904,11 @@ Internally this serializes the anonymous function into string and sends it to ba + +
    Source:
    +
    @@ -7376,7 +6943,7 @@ Internally this serializes the anonymous function into string and sends it to ba
    -Promise +Promise.<void>
    @@ -7394,7 +6961,7 @@ Internally this serializes the anonymous function into string and sends it to ba -

    setupElementTooltip($el)

    +

    setupElementTooltip($el) → {Promise.<void>}

    @@ -7450,7 +7017,7 @@ Internally this serializes the anonymous function into string and sends it to ba - jquery object on which to setup the tooltip + jquery object on which to set up the tooltip @@ -7488,6 +7055,11 @@ Internally this serializes the anonymous function into string and sends it to ba + +
    Source:
    +
    @@ -7511,6 +7083,24 @@ Internally this serializes the anonymous function into string and sends it to ba +
    Returns:
    + + + + +
    +
    + Type +
    +
    + +Promise.<void> + + +
    +
    + + @@ -7620,6 +7210,11 @@ Internally this serializes the anonymous function into string and sends it to ba + +
    Source:
    +
    @@ -7752,6 +7347,11 @@ Internally this serializes the anonymous function into string and sends it to ba + +
    Source:
    +
    @@ -7907,6 +7507,11 @@ Internally this serializes the anonymous function into string and sends it to ba + +
    Source:
    +
    @@ -8062,6 +7667,11 @@ Internally this serializes the anonymous function into string and sends it to ba + +
    Source:
    +
    @@ -8096,7 +7706,7 @@ Internally this serializes the anonymous function into string and sends it to ba -

    waitUntilSynced()

    +

    waitUntilSynced() → {Promise.<void>}

    @@ -8149,6 +7759,11 @@ Typical use case is when new note has been created, we should wait until it is s + +
    Source:
    +
    @@ -8172,6 +7787,24 @@ Typical use case is when new note has been created, we should wait until it is s +
    Returns:
    + + + + +
    +
    + Type +
    +
    + +Promise.<void> + + +
    +
    + + @@ -8199,7 +7832,7 @@ Typical use case is when new note has been created, we should wait until it is s
    diff --git a/docs/frontend_api/index.html b/docs/frontend_api/index.html index e6417de05..08a8eb159 100644 --- a/docs/frontend_api/index.html +++ b/docs/frontend_api/index.html @@ -56,7 +56,7 @@
    diff --git a/package-lock.json b/package-lock.json index 72f6edf04..d20055f8d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -84,7 +84,7 @@ "electron-rebuild": "3.2.9", "esm": "3.2.25", "jasmine": "4.5.0", - "jsdoc": "4.0.0", + "jsdoc": "4.0.1", "lorem-ipsum": "2.0.8", "rcedit": "3.0.1", "webpack": "5.75.0", @@ -6382,9 +6382,9 @@ "integrity": "sha1-peZUwuWi3rXyAdls77yoDA7y9RM=" }, "node_modules/jsdoc": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-4.0.0.tgz", - "integrity": "sha512-tzTgkklbWKrlaQL2+e3NNgLcZu3NaK2vsHRx7tyHQ+H5jcB9Gx0txSd2eJWlMC/xU1+7LQu4s58Ry0RkuaEQVg==", + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-4.0.1.tgz", + "integrity": "sha512-UjvSrLYb270Mq25RN4AGGg2uqKRV90nCqkGsI4gD3RIR1lgMN8nWxK/am8Rsj33tWyprzZdA+0q1qY07m0Ar7w==", "dev": true, "dependencies": { "@babel/parser": "^7.9.4", @@ -15523,9 +15523,9 @@ "integrity": "sha1-peZUwuWi3rXyAdls77yoDA7y9RM=" }, "jsdoc": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-4.0.0.tgz", - "integrity": "sha512-tzTgkklbWKrlaQL2+e3NNgLcZu3NaK2vsHRx7tyHQ+H5jcB9Gx0txSd2eJWlMC/xU1+7LQu4s58Ry0RkuaEQVg==", + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-4.0.1.tgz", + "integrity": "sha512-UjvSrLYb270Mq25RN4AGGg2uqKRV90nCqkGsI4gD3RIR1lgMN8nWxK/am8Rsj33tWyprzZdA+0q1qY07m0Ar7w==", "dev": true, "requires": { "@babel/parser": "^7.9.4", diff --git a/package.json b/package.json index 21ff38607..451d2cf99 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,7 @@ "switch-server": "rm -rf ./node_modules/better-sqlite3 && npm install", "switch-electron": "rm -rf ./node_modules/better-sqlite3 && npm install && ./node_modules/.bin/electron-rebuild", "build-backend-docs": "rm -rf ./docs/backend_api && ./node_modules/.bin/jsdoc -c jsdoc-conf.json -d ./docs/backend_api src/becca/entities/*.js src/services/backend_script_api.js src/services/sql.js", - "build-frontend-docs": "rm -rf ./docs/frontend_api && ./node_modules/.bin/jsdoc -c jsdoc-conf.json -d ./docs/frontend_api src/public/app/entities/*.js src/public/app/services/frontend_script_api.js src/public/app/widgets/collapsible_widget.js", + "build-frontend-docs": "rm -rf ./docs/frontend_api && ./node_modules/.bin/jsdoc -c jsdoc-conf.json -d ./docs/frontend_api src/public/app/entities/*.js src/public/app/services/frontend_script_api.js", "build-docs": "npm run build-backend-docs && npm run build-frontend-docs", "webpack": "npx webpack -c webpack-desktop.config.js && npx webpack -c webpack-mobile.config.js && npx webpack -c webpack-setup.config.js", "test-jasmine": "jasmine",