- - 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);
+
- 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
- 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:
-
-
-
-
-
-
- | Name |
-
-
- Type |
-
-
- Attributes |
-
-
-
-
- Description |
-
-
-
-
-
-
-
-
- date |
-
-
-
-
-
-string
-
-
-
- |
-
-
-
-
-
-
-
-
- |
-
-
-
-
- in YYYY-MM-DD format |
-
-
-
-
-
-
- rootNote |
-
-
-
-
-
-BNote
-
-
-
- |
-
-
-
-
- <optional>
-
-
-
-
-
- |
-
-
-
-
- specify calendar root note, normally leave empty to use default calendar |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Deprecated:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-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
+
+
+
+
+
+
+ | Name |
+
+
+ Type |
+
+
+ Attributes |
+
+
+
+ Default |
+
+
+ Description |
+
+
+
+
+
+
+
+
+ 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
- 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
- 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
- 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
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - 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:
-
-
-
-
-
-
- | Name |
-
-
- Type |
-
-
- Attributes |
-
-
-
-
- Description |
-
-
-
-
-
-
-
-
- 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:
-
-
-
-
-
-
- | Name |
-
-
- Type |
-
-
-
-
-
- Description |
-
-
-
-
-
-
-
-
- date |
-
-
-
-
-
-string
-
-
-
- |
-
-
-
-
-
- e.g. "2019-04-29" |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Deprecated:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-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
-
+
@@ -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",