Update API Docs

docs/backend_api/AbstractBeccaEntity.html

@@ -828,9 +828,7 @@
 
 
 <div class="description">
-    Mark the entity as (soft) deleted. It will be completely erased later.
+    Mark the entity as (soft) deleted. It will be completely erased later.
-
-This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
 
 This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
 </div>
@@ -1174,7 +1172,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
 
 
 </div>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+
 <nav>
     <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>

docs/backend_api/BAttribute.html

@@ -30,8 +30,7 @@
     
         <h2><span class="attribs"><span class="type-signature"></span></span>BAttribute<span class="signature">()</span><span class="type-signature"></span></h2>
         
-            <div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair)
+            <div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair)
-and relation (representing named relationship between source and target note)</div>
 and relation (representing named relationship between source and target note)</div>
         
     
@@ -94,7 +93,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line16">line 16</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line22">line 22</a>
     </li></ul></dd>
     
@@ -205,7 +204,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line47">line 47</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line53">line 53</a>
     </li></ul></dd>
     
@@ -336,7 +335,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line59">line 59</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line65">line 65</a>
     </li></ul></dd>
     
@@ -404,7 +403,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line53">line 53</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line59">line 59</a>
     </li></ul></dd>
     
@@ -464,74 +463,6 @@ and relation (representing named relationship between source and target note)</d
 
     
 
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line49">line 49</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"> :int</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">int</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
     
 
     
@@ -558,7 +489,7 @@ and relation (representing named relationship between source and target note)</d
 
 
         
-<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
+            
 <h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"> :<a href="global.html#int">int</a></span></h4>
 
 
@@ -569,7 +500,7 @@ and relation (representing named relationship between source and target note)</d
     <h5>Type:</h5>
     <ul>
         <li>
-<span class="param-type">string</span>
+            
 <span class="param-type"><a href="global.html#int">int</a></span>
 
 
@@ -608,7 +539,75 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line51">line 51</a>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line61">line 61</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :<a href="global.html#AttributeType">AttributeType</a></span></h4>
+
+
+
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type"><a href="global.html#AttributeType">AttributeType</a></span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line57">line 57</a>
     </li></ul></dd>
     
@@ -676,7 +675,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line61">line 61</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line67">line 67</a>
     </li></ul></dd>
     
@@ -744,7 +743,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line57">line 57</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line63">line 63</a>
     </li></ul></dd>
     
@@ -1286,7 +1285,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line129">line 129</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line135">line 135</a>
     </li></ul></dd>
     
@@ -1480,7 +1479,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line142">line 142</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line148">line 148</a>
     </li></ul></dd>
     
@@ -1674,7 +1673,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line157">line 157</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line163">line 163</a>
     </li></ul></dd>
     
@@ -1736,9 +1735,7 @@ and relation (representing named relationship between source and target note)</d
 
 
 
-    Mark the entity as (soft) deleted. It will be completely erased later.
+<div class="description">
-
-This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
     Mark the entity as (soft) deleted. It will be completely erased later.
 
 This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
@@ -2097,7 +2094,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
 
 
 
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+</div>
 
 <nav>
     <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>

docs/backend_api/BBranch.html

@@ -30,11 +30,7 @@
     
         <h2><span class="attribs"><span class="type-signature"></span></span>BBranch<span class="signature">()</span><span class="type-signature"></span></h2>
         
-            <div class="class-description">Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
+            <div class="class-description">Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
-parents.
-
-Note that you should not rely on the branch's identity, since it can change easily with a note's move.
-Always check noteId instead.</div>
 parents.
 
 Note that you should not rely on the branch's identity, since it can change easily with a note's move.
@@ -421,11 +417,7 @@ Always check noteId instead.</div>
             
 <h4 class="name" id="isWeak"><span class="type-signature"></span>isWeak<span class="type-signature"></span></h4>
 
-    Branch is weak when its existence should not hinder deletion of its note.
+
-As a result, note with only weak branches should be immediately deleted.
-An example is shared or bookmarked clones - they are created automatically and exist for technical reasons,
-not as user-intended actions. From user perspective, they don't count as real clones and for the purpose
-of deletion should not act as a clone.
 
 
 <div class="description">
@@ -549,7 +541,7 @@ of deletion should not act as a clone.
 
     
 </dl>
-<h4 class="name" id="notePosition"><span class="type-signature"></span>notePosition<span class="type-signature"> :int</span></h4>
+
 
 
 
@@ -560,7 +552,7 @@ of deletion should not act as a clone.
 <h4 class="name" id="notePosition"><span class="type-signature"></span>notePosition<span class="type-signature"> :<a href="global.html#int">int</a></span></h4>
 
 
-<span class="param-type">int</span>
+
 
 
 
@@ -1850,9 +1842,7 @@ of deletion should not act as a clone.
     
 
     
-    Mark the entity as (soft) deleted. It will be completely erased later.
+    <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDeleted<span class="signature">(deleteId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
-
-This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
     
 
     
@@ -2211,7 +2201,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+</article>
 
 </section>
 

docs/backend_api/BEtapiToken.html

@@ -30,13 +30,7 @@
     
         <h2><span class="attribs"><span class="type-signature"></span></span>BEtapiToken<span class="signature">()</span><span class="type-signature"></span></h2>
         
-            <div class="class-description">EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications.
+            <div class="class-description">EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications.
-Used by:
-- Trilium Sender
-- ETAPI clients
-
-The format user is presented with is "<etapiTokenId>_<tokenHash>". This is also called "authToken" to distinguish it
-from tokenHash and token.</div>
 Used by:
 - Trilium Sender
 - ETAPI clients
@@ -1293,9 +1287,7 @@ from tokenHash and token.</div>
     
     <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDeleted<span class="signature">(deleteId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
     
-    Mark the entity as (soft) deleted. It will be completely erased later.
+
-
-This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
     
 
 
@@ -1654,7 +1646,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
     
 </article>
 
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+</section>
 
 
 

docs/backend_api/BNote.html

@@ -93,7 +93,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line25">line 25</a>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line40">line 40</a>
     </li></ul></dd>
     
 
@@ -207,7 +207,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line90">line 90</a>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line108">line 108</a>
     </li></ul></dd>
     
 
@@ -338,7 +338,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line70">line 70</a>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line85">line 85</a>
     </li></ul></dd>
     
 
@@ -406,7 +406,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line72">line 72</a>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line87">line 87</a>
     </li></ul></dd>
     
 
@@ -474,7 +474,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line74">line 74</a>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line89">line 89</a>
     </li></ul></dd>
     
 
@@ -498,7 +498,7 @@
 
 
 <div class="description">
-    - set during the deletion operation, before it is completed (removed from becca completely)
+    set during the deletion operation, before it is completed (removed from becca completely)
 </div>
 
 
@@ -546,7 +546,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line80">line 80</a>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line98">line 98</a>
     </li></ul></dd>
     
 
@@ -614,7 +614,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line85">line 85</a>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line103">line 103</a>
     </li></ul></dd>
     
 
@@ -682,7 +682,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line68">line 68</a>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line83">line 83</a>
     </li></ul></dd>
     
 
@@ -750,7 +750,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line66">line 66</a>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line81">line 81</a>
     </li></ul></dd>
     
 
@@ -818,7 +818,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line60">line 60</a>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line75">line 75</a>
     </li></ul></dd>
     
 
@@ -886,7 +886,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line62">line 62</a>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line77">line 77</a>
     </li></ul></dd>
     
 
@@ -904,7 +904,7 @@
 
         
             
-<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
+<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :<a href="global.html#NoteType">NoteType</a></span></h4>
 
 
 
@@ -915,7 +915,7 @@
     <ul>
         <li>
             
-<span class="param-type">string</span>
+<span class="param-type"><a href="global.html#NoteType">NoteType</a></span>
 
 
         </li>
@@ -954,7 +954,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line64">line 64</a>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line79">line 79</a>
     </li></ul></dd>
     
 
@@ -1022,7 +1022,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line76">line 76</a>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line91">line 91</a>
     </li></ul></dd>
     
 
@@ -1090,7 +1090,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line78">line 78</a>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line93">line 93</a>
     </li></ul></dd>
     
 
@@ -1325,8 +1325,7 @@
 
 
 <div class="description">
-    Adds a new attribute to this note. The attribute is saved and returned.
+    Adds a new attribute to this note. The attribute is saved and returned.
-See addLabel, addRelation for more specific methods.
 See addLabel, addRelation for more specific methods.
 </div>
 
@@ -1518,7 +1517,7 @@ See addLabel, addRelation for more specific methods.
 
             <td class="type">
             
-<span class="param-type">int</span>
+                
 <span class="param-type"><a href="global.html#int">int</a></span>
 |
 
@@ -1588,7 +1587,7 @@ See addLabel, addRelation for more specific methods.
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1308">line 1308</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1326">line 1326</a>
     </li></ul></dd>
     
@@ -1835,7 +1834,7 @@ See addLabel, addRelation for more specific methods.
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1329">line 1329</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1347">line 1347</a>
     </li></ul></dd>
     
@@ -1897,8 +1896,7 @@ See addLabel, addRelation for more specific methods.
 
 
 
-    Adds a new relation to this note. The relation attribute is saved and
+<div class="description">
-returned.
     Adds a new relation to this note. The relation attribute is saved and
 returned.
 </div>
@@ -2081,7 +2079,7 @@ returned.
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1342">line 1342</a>
+    <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1360">line 1360</a>
     </li></ul></dd>
@@ -2316,7 +2314,7 @@ returned.
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1427">line 1427</a>
+    <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1445">line 1445</a>
     </li></ul></dd>
@@ -2378,17 +2376,7 @@ returned.
     
 
 
-    Some notes are eligible for conversion into an attachment of its parent, note must have these properties:
+
-- it has exactly one target relation
-- it has a relation from its parent note
-- it has no children
-- it has no clones
-- the parent is of type text
-- both notes are either unprotected or user is in protected session
-
-Currently, works only for image notes.
-
-In the future, this functionality might get more generic and some of the requirements relaxed.
 <div class="description">
     Some notes are eligible for conversion into an attachment of its parent, note must have these properties:
 - it has exactly one target relation
@@ -2432,7 +2420,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1479">line 1479</a>
+
     
 
     
@@ -2653,7 +2641,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1517">line 1517</a>
+
     
 
     
@@ -2919,7 +2907,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1149">line 1149</a>
+
     
 
     
@@ -3025,7 +3013,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1037">line 1037</a>
+
     
 
     
@@ -3127,7 +3115,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1011">line 1011</a>
+
     
 
     
@@ -3229,7 +3217,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1118">line 1118</a>
+
     
 
     
@@ -3334,7 +3322,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1133">line 1133</a>
+
     
 
     
@@ -3436,7 +3424,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1100">line 1100</a>
+
     
 
     
@@ -3610,7 +3598,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line574">line 574</a>
+
     
 
     
@@ -3639,8 +3627,7 @@ In the future, this functionality might get more generic and some of the require
 
 
 
-    attribute of the given type and name. If there are more such attributes, first is returned.
+
-                      Returns null if there's no such attribute belonging to this note.
 
 
 
@@ -3789,7 +3776,7 @@ In the future, this functionality might get more generic and some of the require
 
     
 
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line585">line 585</a>
+    
 
     
 
@@ -3858,8 +3845,7 @@ In the future, this functionality might get more generic and some of the require
 
 
         
-    Beware that the method must not create a copy of the array, but actually returns its internal array
+            
-(for performance reasons)
 
     
 
@@ -3997,7 +3983,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line327">line 327</a>
+
     
 
     
@@ -4176,7 +4162,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1202">line 1202</a>
+
     
 
     
@@ -4355,7 +4341,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1212">line 1212</a>
+
     
 
     
@@ -4463,7 +4449,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line176">line 176</a>
+        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>use getParentBranches() instead</li></ul></dd>
     
 
     
@@ -4565,7 +4551,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line196">line 196</a>
+
     
 
     
@@ -4667,7 +4653,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line186">line 186</a>
+
     
 
     
@@ -4769,7 +4755,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line210">line 210</a>
+
     
 
     
@@ -4874,7 +4860,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line215">line 215</a>
+
     
 
     
@@ -4978,7 +4964,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line958">line 958</a>
+        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>use getSubtreeNoteIds() instead</li></ul></dd>
     
 
     
@@ -5022,9 +5008,7 @@ In the future, this functionality might get more generic and some of the require
 
 
 
-    This is used for:
+        
-- fast searching
-- note similarity evaluation
             
 
     
@@ -5068,7 +5052,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line759">line 759</a>
+
     
 
     
@@ -5174,7 +5158,7 @@ In the future, this functionality might get more generic and some of the require
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1063">line 1063</a>
+
     
 
     
@@ -5203,8 +5187,7 @@ In the future, this functionality might get more generic and some of the require
 
 
 
-    - returns only notes which are templated, does not include their subtrees
+
-                    in effect returns notes which are influenced by note's non-inheritable attributes
 
 
 
@@ -5281,7 +5264,7 @@ In the future, this functionality might get more generic and some of the require
 
     
 
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line220">line 220</a>
+    
 
     
 
@@ -5432,7 +5415,7 @@ In the future, this functionality might get more generic and some of the require
 
     
 
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line514">line 514</a>
+    
 
     
 
@@ -5590,7 +5573,7 @@ In the future, this functionality might get more generic and some of the require
 
     
 
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line538">line 538</a>
+    
 
     
 
@@ -5760,7 +5743,7 @@ In the future, this functionality might get more generic and some of the require
 
     
 
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line614">line 614</a>
+    
 
     
 
@@ -5927,7 +5910,7 @@ In the future, this functionality might get more generic and some of the require
 
     
 
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line606">line 606</a>
+    
 
     
 
@@ -6033,7 +6016,7 @@ In the future, this functionality might get more generic and some of the require
 
     
 
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line684">line 684</a>
+    
 
     
 
@@ -6062,9 +6045,7 @@ In the future, this functionality might get more generic and some of the require
 </dl>
 
 
-    attribute belonging to this specific note (excludes inherited attributes)
+
-
-This method can be significantly faster than the getAttribute()
 
 
 
@@ -6213,7 +6194,7 @@ This method can be significantly faster than the getAttribute()
 
     
 
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line596">line 596</a>
+    
 
     
 
@@ -6282,8 +6263,7 @@ This method can be significantly faster than the getAttribute()
 </dl>
 
     
-    Beware that the method must not create a copy of the array, but actually returns its internal array
+
-(for performance reasons)
 
 
 
@@ -6483,7 +6463,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line659">line 659</a>
+
     
 
     
@@ -6638,7 +6618,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line520">line 520</a>
+
     
 
     
@@ -6796,7 +6776,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line544">line 544</a>
+
     
 
     
@@ -6966,7 +6946,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line630">line 630</a>
+
     
 
     
@@ -7133,7 +7113,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line622">line 622</a>
+
     
 
     
@@ -7288,7 +7268,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line532">line 532</a>
+
     
 
     
@@ -7446,7 +7426,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line556">line 556</a>
+
     
 
     
@@ -7616,7 +7596,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line646">line 646</a>
+
     
 
     
@@ -7722,7 +7702,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line159">line 159</a>
+
     
 
     
@@ -7824,7 +7804,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line181">line 181</a>
+
     
 
     
@@ -8064,7 +8044,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line526">line 526</a>
+
     
 
     
@@ -8222,7 +8202,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line550">line 550</a>
+
     
 
     
@@ -8392,7 +8372,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line638">line 638</a>
+
     
 
     
@@ -8498,7 +8478,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1094">line 1094</a>
+
     
 
     
@@ -8600,7 +8580,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line303">line 303</a>
+
     
 
     
@@ -8709,7 +8689,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line869">line 869</a>
+
     
 
     
@@ -8763,7 +8743,7 @@ This method can be significantly faster than the getAttribute()
     <dt>
         Type
     </dt>
-    <h4 class="name" id="getSortedNotePathRecords"><span class="type-signature"></span>getSortedNotePathRecords<span class="signature">(hoistedNoteId<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;{isArchived: boolean, isInHoistedSubTree: boolean, notePath: Array.&lt;string>, isHidden: boolean}>}</span></h4>
+    <dd>
         
 <span class="param-type">Array.&lt;<a href="BNote.html">BNote</a>></span>
 
@@ -8880,7 +8860,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1171">line 1171</a>
+
     
 
     
@@ -8916,7 +8896,7 @@ This method can be significantly faster than the getAttribute()
 
 
 
-<span class="param-type">Array.&lt;{isArchived: boolean, isInHoistedSubTree: boolean, notePath: Array.&lt;string>, isHidden: boolean}></span>
+
 
 
 
@@ -8986,7 +8966,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line168">line 168</a>
+
     
 
     
@@ -9088,7 +9068,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line892">line 892</a>
+
     
 
     
@@ -9190,7 +9170,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line951">line 951</a>
+
     
 
     
@@ -9296,7 +9276,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line837">line 837</a>
+
     
 
     
@@ -9398,7 +9378,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1057">line 1057</a>
+
     
 
     
@@ -9589,7 +9569,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1042">line 1042</a>
+
     
 
     
@@ -9815,7 +9795,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line444">line 444</a>
+
     
 
     
@@ -9917,7 +9897,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line191">line 191</a>
+
     
 
     
@@ -10111,7 +10091,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line473">line 473</a>
+
     
 
     
@@ -10340,7 +10320,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line564">line 564</a>
+
     
 
     
@@ -10538,7 +10518,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line494">line 494</a>
+
     
 
     
@@ -10736,7 +10716,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line508">line 508</a>
+
     
 
     
@@ -10934,7 +10914,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line501">line 501</a>
+
     
 
     
@@ -11040,7 +11020,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line298">line 298</a>
+
     
 
     
@@ -11190,7 +11170,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1243">line 1243</a>
+
     
 
     
@@ -11296,7 +11276,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1221">line 1221</a>
+
     
 
     
@@ -11390,7 +11370,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line281">line 281</a>
+
     
 
     
@@ -11496,7 +11476,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line287">line 287</a>
+
     
 
     
@@ -11602,7 +11582,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line273">line 273</a>
+
     
 
     
@@ -11708,7 +11688,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line268">line 268</a>
+
     
 
     
@@ -11863,7 +11843,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line479">line 479</a>
+
     
 
     
@@ -11969,7 +11949,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line263">line 263</a>
+
     
 
     
@@ -12077,7 +12057,7 @@ This method can be significantly faster than the getAttribute()
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line293">line 293</a>
+
     
 
     
@@ -12121,9 +12101,7 @@ This method can be significantly faster than the getAttribute()
 
 
 
-    Mark the entity as (soft) deleted. It will be completely erased later.
+
-
-This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
 
 
 
@@ -12536,7 +12514,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1287">line 1287</a>
+
     
 
     
@@ -12716,7 +12694,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1403">line 1403</a>
+
     
 
     
@@ -12896,7 +12874,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1411">line 1411</a>
+
     
 
     
@@ -13091,7 +13069,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1624">line 1624</a>
+
     
 
     
@@ -13193,7 +13171,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1571">line 1571</a>
+
     
 
     
@@ -13425,7 +13403,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1256">line 1256</a>
+
     
 
     
@@ -13704,7 +13682,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line236">line 236</a>
+
     
 
     
@@ -13884,7 +13862,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1387">line 1387</a>
+
     
 
     
@@ -14044,7 +14022,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1395">line 1395</a>
+
     
 
     
@@ -14286,7 +14264,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1354">line 1354</a>
+
     
 
     
@@ -14497,7 +14475,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1370">line 1370</a>
+
     
 
     
@@ -14708,7 +14686,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1379">line 1379</a>
+
     
 
     
@@ -14754,7 +14732,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
 
 
 
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+
 
 
 

docs/backend_api/BOption.html

@@ -1151,9 +1151,7 @@
 
 
 <div class="description">
-    Mark the entity as (soft) deleted. It will be completely erased later.
+    Mark the entity as (soft) deleted. It will be completely erased later.
-
-This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
 
 This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
 </div>
@@ -1512,7 +1510,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
 
 
 </div>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+
 <nav>
     <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>

docs/backend_api/BRecentNote.html

@@ -1083,9 +1083,7 @@
 
 
 <div class="description">
-    Mark the entity as (soft) deleted. It will be completely erased later.
+    Mark the entity as (soft) deleted. It will be completely erased later.
-
-This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
 
 This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
 </div>
@@ -1444,7 +1442,7 @@ This is a low-level method, for notes and branches use `note.deleteNote()` and '
 
 
 </div>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+
 <nav>
     <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>

docs/backend_api/becca_entities_abstract_becca_entity.js.html

@@ -341,7 +341,7 @@ module.exports = AbstractBeccaEntity;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/backend_api/becca_entities_battachment.js.html

@@ -0,0 +1,290 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: becca/entities/battachment.js</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Source: becca/entities/battachment.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>"use strict";
+
+const utils = require('../../services/utils');
+const dateUtils = require('../../services/date_utils');
+const AbstractBeccaEntity = require("./abstract_becca_entity");
+const sql = require("../../services/sql");
+const protectedSessionService = require("../../services/protected_session");
+const log = require("../../services/log");
+
+const attachmentRoleToNoteTypeMapping = {
+    'image': 'image'
+};
+
+/**
+ * Attachment represent data related/attached to the note. Conceptually similar to attributes, but intended for
+ * larger amounts of data and generally not accessible to the user.
+ *
+ * @extends AbstractBeccaEntity
+ */
+class BAttachment extends AbstractBeccaEntity {
+    static get entityName() { return "attachments"; }
+    static get primaryKeyName() { return "attachmentId"; }
+    static get hashedProperties() { return ["attachmentId", "ownerId", "role", "mime", "title", "blobId",
+                                            "utcDateScheduledForErasureSince", "utcDateModified"]; }
+
+    constructor(row) {
+        super();
+
+        if (!row.ownerId?.trim()) {
+            throw new Error("'ownerId' must be given to initialize a Attachment entity");
+        } else if (!row.role?.trim()) {
+            throw new Error("'role' must be given to initialize a Attachment entity");
+        } else if (!row.mime?.trim()) {
+            throw new Error("'mime' must be given to initialize a Attachment entity");
+        } else if (!row.title?.trim()) {
+            throw new Error("'title' must be given to initialize a Attachment entity");
+        }
+
+        /** @type {string} */
+        this.attachmentId = row.attachmentId;
+        /** 
+         * either noteId or revisionId to which this attachment belongs
+         * @type {string}
+         */
+        this.ownerId = row.ownerId;
+        /** @type {string} */
+        this.role = row.role;
+        /** @type {string} */
+        this.mime = row.mime;
+        /** @type {string} */
+        this.title = row.title;
+        /** @type {int} */
+        this.position = row.position;
+        /** @type {string} */
+        this.blobId = row.blobId;
+        /** @type {boolean} */
+        this.isProtected = !!row.isProtected;
+        /** @type {string} */
+        this.dateModified = row.dateModified;
+        /** @type {string} */
+        this.utcDateModified = row.utcDateModified;
+        /** @type {string} */
+        this.utcDateScheduledForErasureSince = row.utcDateScheduledForErasureSince;
+
+        /**
+         * optionally added to the entity
+         * @type {int}
+         */
+        this.contentLength = row.contentLength;
+
+        this.decrypt();
+    }
+
+    /** @returns {BAttachment} */
+    copy() {
+        return new BAttachment({
+            ownerId: this.ownerId,
+            role: this.role,
+            mime: this.mime,
+            title: this.title,
+            blobId: this.blobId,
+            isProtected: this.isProtected
+        });
+    }
+
+    /** @returns {BNote} */
+    getNote() {
+        return this.becca.notes[this.ownerId];
+    }
+
+    /** @returns {boolean} true if the note has string content (not binary) */
+    hasStringContent() {
+        return utils.isStringNote(this.type, this.mime);
+    }
+
+    isContentAvailable() {
+        return !this.attachmentId // new attachment which was not encrypted yet
+            || !this.isProtected
+            || protectedSessionService.isProtectedSessionAvailable()
+    }
+
+    getTitleOrProtected() {
+        return this.isContentAvailable() ? this.title : '[protected]';
+    }
+
+    decrypt() {
+        if (this.isProtected &amp;&amp; !this.isDecrypted &amp;&amp; protectedSessionService.isProtectedSessionAvailable()) {
+            try {
+                this.title = protectedSessionService.decryptString(this.title);
+                this.isDecrypted = true;
+            }
+            catch (e) {
+                log.error(`Could not decrypt attachment ${this.attachmentId}: ${e.message} ${e.stack}`);
+            }
+        }
+    }
+
+    /** @returns {string|Buffer}  */
+    getContent() {
+        return this._getContent();
+    }
+
+    /**
+     * @param content
+     * @param {object} [opts]
+     * @param {object} [opts.forceSave=false] - will also save this BAttachment entity
+     * @param {object} [opts.forceFrontendReload=false] - override frontend heuristics on when to reload, instruct to reload
+     */
+    setContent(content, opts) {
+        this._setContent(content, opts);
+    }
+
+    /** @returns {{note: BNote, branch: BBranch}} */
+    convertToNote() {
+        if (this.type === 'search') {
+            throw new Error(`Note of type search cannot have child notes`);
+        }
+
+        if (!this.getNote()) {
+            throw new Error("Cannot find note of this attachment. It is possible that this is note revision's attachment. " +
+                "Converting note revision's attachments to note is not (yet) supported.");
+        }
+
+        if (!(this.role in attachmentRoleToNoteTypeMapping)) {
+            throw new Error(`Mapping from attachment role '${this.role}' to note's type is not defined`);
+        }
+
+        if (!this.isContentAvailable()) { // isProtected is the same for attachment
+            throw new Error(`Cannot convert protected attachment outside of protected session`);
+        }
+
+        const noteService = require('../../services/notes');
+
+        const { note, branch } = noteService.createNewNote({
+            parentNoteId: this.ownerId,
+            title: this.title,
+            type: attachmentRoleToNoteTypeMapping[this.role],
+            mime: this.mime,
+            content: this.getContent(),
+            isProtected: this.isProtected
+        });
+
+        this.markAsDeleted();
+
+        const parentNote = this.getNote();
+
+        if (this.role === 'image' &amp;&amp; parentNote.type === 'text') {
+            const origContent = parentNote.getContent();
+            const oldAttachmentUrl = `api/attachments/${this.attachmentId}/image/`;
+            const newNoteUrl = `api/images/${note.noteId}/`;
+
+            const fixedContent = utils.replaceAll(origContent, oldAttachmentUrl, newNoteUrl);
+
+            if (fixedContent !== origContent) {
+                parentNote.setContent(fixedContent);
+            }
+
+            noteService.asyncPostProcessContent(note, fixedContent);
+        }
+
+        return { note, branch };
+    }
+
+    getFileName() {
+        const type = this.role === 'image' ? 'image' : 'file';
+
+        return utils.formatDownloadTitle(this.title, type, this.mime);
+    }
+
+    beforeSaving() {
+        super.beforeSaving();
+
+        if (this.position === undefined || this.position === null) {
+            this.position = 10 + sql.getValue(`SELECT COALESCE(MAX(position), 0)
+                                              FROM attachments
+                                              WHERE ownerId = ?`, [this.noteId]);
+        }
+
+        this.dateModified = dateUtils.localNowDateTime();
+        this.utcDateModified = dateUtils.utcNowDateTime();
+    }
+
+    getPojo() {
+        return {
+            attachmentId: this.attachmentId,
+            ownerId: this.ownerId,
+            role: this.role,
+            mime: this.mime,
+            title: this.title,
+            position: this.position,
+            blobId: this.blobId,
+            isProtected: !!this.isProtected,
+            isDeleted: false,
+            dateModified: this.dateModified,
+            utcDateModified: this.utcDateModified,
+            utcDateScheduledForErasureSince: this.utcDateScheduledForErasureSince,
+            contentLength: this.contentLength
+        };
+    }
+
+    getPojoToSave() {
+        const pojo = this.getPojo();
+        delete pojo.contentLength;
+
+        if (pojo.isProtected) {
+            if (this.isDecrypted) {
+                pojo.title = protectedSessionService.encrypt(pojo.title);
+            }
+            else {
+                // updating protected note outside of protected session means we will keep original ciphertexts
+                delete pojo.title;
+            }
+        }
+
+        return pojo;
+    }
+}
+
+module.exports = BAttachment;
+</code></pre>
+        </article>
+    </section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

docs/backend_api/becca_entities_battribute.js.html

@@ -35,6 +35,12 @@ const dateUtils = require("../../services/date_utils");
 const promotedAttributeDefinitionParser = require("../../services/promoted_attribute_definition_parser");
 const {sanitizeAttributeName} = require("../../services/sanitize_attribute_name");
 
+
+/**
+ * There are currently only two types of attributes, labels or relations.
+ * @typedef {"label" | "relation"} AttributeType
+ */
+
 /**
  * Attribute is an abstract concept which has two real uses - label (key - value pair)
  * and relation (representing named relationship between source and target note)
@@ -75,7 +81,7 @@ class BAttribute extends AbstractBeccaEntity {
         this.attributeId = attributeId;
         /** @type {string} */
         this.noteId = noteId;
-        /** @type {string} */
+        /** @type {AttributeType} */
         this.type = type;
         /** @type {string} */
         this.name = name;
@@ -272,7 +278,7 @@ module.exports = BAttribute;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/backend_api/becca_entities_bblob.js.html

@@ -0,0 +1,81 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: becca/entities/bblob.js</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Source: becca/entities/bblob.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>class BBlob {
+    static get entityName() { return "blobs"; }
+    static get primaryKeyName() { return "blobId"; }
+    static get hashedProperties() { return ["blobId", "content"]; }
+
+    constructor(row) {
+        /** @type {string} */
+        this.blobId = row.blobId;
+        /** @type {string|Buffer} */
+        this.content = row.content;
+        /** @type {int} */
+        this.contentLength = row.contentLength;
+        /** @type {string} */
+        this.dateModified = row.dateModified;
+        /** @type {string} */
+        this.utcDateModified = row.utcDateModified;
+    }
+
+    getPojo() {
+        return {
+            blobId: this.blobId,
+            content: this.content,
+            contentLength: this.contentLength,
+            dateModified: this.dateModified,
+            utcDateModified: this.utcDateModified
+        };
+    }
+}
+
+module.exports = BBlob;
+</code></pre>
+        </article>
+    </section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

docs/backend_api/becca_entities_bbranch.js.html

@@ -318,7 +318,7 @@ module.exports = BBranch;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/backend_api/becca_entities_betapi_token.js.html

@@ -114,7 +114,7 @@ module.exports = BEtapiToken;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/backend_api/becca_entities_bnote.js.html

@@ -45,6 +45,21 @@ dayjs.extend(utc);
 const LABEL = 'label';
 const RELATION = 'relation';
 
+/**
+ * There are many different Note types, some of which are entirely opaque to the
+ * end user. Those types should be used only for checking against, they are
+ * not for direct use.
+ * @typedef {"file" | "image" | "search" | "noteMap" | "launcher" | "doc" | "contentWidget" | "text" | "relationMap" | "render" | "canvas" | "mermaid" | "book" | "webView" | "code"} NoteType
+ */
+
+/**
+ * @typedef {Object} NotePathRecord
+ * @property {boolean} isArchived
+ * @property {boolean} isInHoistedSubTree
+ * @property {Array<string>} notePath
+ * @property {boolean} isHidden
+ */
+
 /**
  * Trilium's main entity, which can represent text note, image, code note, file attachment etc.
  *
@@ -88,7 +103,7 @@ class BNote extends AbstractBeccaEntity {
         this.noteId = noteId;
         /** @type {string} */
         this.title = title;
-        /** @type {string} */
+        /** @type {NoteType} */
         this.type = type;
         /** @type {string} */
         this.mime = mime;
@@ -104,7 +119,10 @@ class BNote extends AbstractBeccaEntity {
         this.utcDateCreated = utcDateCreated || dateUtils.utcNowDateTime();
         /** @type {string} */
         this.utcDateModified = utcDateModified;
-        /** @type {boolean} - set during the deletion operation, before it is completed (removed from becca completely) */
+        /** 
+         * set during the deletion operation, before it is completed (removed from becca completely)
+         * @type {boolean}
+         */
         this.isBeingDeleted = false;
 
         // ------ Derived attributes ------
@@ -1194,7 +1212,7 @@ class BNote extends AbstractBeccaEntity {
 
     /**
      * @param {string} [hoistedNoteId='root']
-     * @return {Array<{isArchived: boolean, isInHoistedSubTree: boolean, notePath: Array<string>, isHidden: boolean}>}
+     * @return {Array<NotePathRecord>}
      */
     getSortedNotePathRecords(hoistedNoteId = 'root') {
         const isHoistedRoot = hoistedNoteId === 'root';
@@ -1638,10 +1656,10 @@ class BNote extends AbstractBeccaEntity {
                     noteContent = noteContent.replaceAll(new RegExp(`href="[^"]*attachmentId=${noteAttachment.attachmentId}[^"]*"`, 'gi'),
                         `href="api/attachments/${revisionAttachment.attachmentId}/download"`);
                 }
-
-                revision.setContent(noteContent, {forceSave: true});
             }
 
+            revision.setContent(noteContent);
+
             return revision;
         });
     }
@@ -1728,7 +1746,7 @@ module.exports = BNote;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/backend_api/becca_entities_boption.js.html

@@ -86,7 +86,7 @@ module.exports = BOption;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/backend_api/becca_entities_brecent_note.js.html

@@ -71,7 +71,7 @@ module.exports = BRecentNote;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/backend_api/becca_entities_brevision.js.html

@@ -0,0 +1,203 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: becca/entities/brevision.js</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Source: becca/entities/brevision.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>"use strict";
+
+const protectedSessionService = require('../../services/protected_session');
+const utils = require('../../services/utils');
+const dateUtils = require('../../services/date_utils');
+const becca = require('../becca');
+const AbstractBeccaEntity = require("./abstract_becca_entity");
+const sql = require("../../services/sql");
+const BAttachment = require("./battachment");
+
+/**
+ * Revision represents a snapshot of note's title and content at some point in the past.
+ * It's used for seamless note versioning.
+ *
+ * @extends AbstractBeccaEntity
+ */
+class BRevision extends AbstractBeccaEntity {
+    static get entityName() { return "revisions"; }
+    static get primaryKeyName() { return "revisionId"; }
+    static get hashedProperties() { return ["revisionId", "noteId", "title", "isProtected", "dateLastEdited", "dateCreated",
+                                            "utcDateLastEdited", "utcDateCreated", "utcDateModified", "blobId"]; }
+
+    constructor(row, titleDecrypted = false) {
+        super();
+
+        /** @type {string} */
+        this.revisionId = row.revisionId;
+        /** @type {string} */
+        this.noteId = row.noteId;
+        /** @type {string} */
+        this.type = row.type;
+        /** @type {string} */
+        this.mime = row.mime;
+        /** @type {boolean} */
+        this.isProtected = !!row.isProtected;
+        /** @type {string} */
+        this.title = row.title;
+        /** @type {string} */
+        this.blobId = row.blobId;
+        /** @type {string} */
+        this.dateLastEdited = row.dateLastEdited;
+        /** @type {string} */
+        this.dateCreated = row.dateCreated;
+        /** @type {string} */
+        this.utcDateLastEdited = row.utcDateLastEdited;
+        /** @type {string} */
+        this.utcDateCreated = row.utcDateCreated;
+        /** @type {string} */
+        this.utcDateModified = row.utcDateModified;
+        /** @type {int} */
+        this.contentLength = row.contentLength;
+
+        if (this.isProtected &amp;&amp; !titleDecrypted) {
+            this.title = protectedSessionService.isProtectedSessionAvailable()
+                ? protectedSessionService.decryptString(this.title)
+                : "[protected]";
+        }
+    }
+
+    getNote() {
+        return becca.notes[this.noteId];
+    }
+
+    /** @returns {boolean} true if the note has string content (not binary) */
+    hasStringContent() {
+        return utils.isStringNote(this.type, this.mime);
+    }
+
+    isContentAvailable() {
+        return !this.revisionId // new note which was not encrypted yet
+            || !this.isProtected
+            || protectedSessionService.isProtectedSessionAvailable()
+    }
+
+    /*
+     * Note revision content has quite special handling - it's not a separate entity, but a lazily loaded
+     * part of Revision entity with its own sync. The reason behind this hybrid design is that
+     * content can be quite large, and it's not necessary to load it / fill memory for any note access even
+     * if we don't need a content, especially for bulk operations like search.
+     *
+     * This is the same approach as is used for Note's content.
+     */
+
+    /** @returns {string|Buffer} */
+    getContent() {
+        return this._getContent();
+    }
+
+    /**
+     * @param content
+     * @param {object} [opts]
+     * @param {object} [opts.forceSave=false] - will also save this BRevision entity
+     */
+    setContent(content, opts) {
+        this._setContent(content, opts);
+    }
+
+    /** @returns {BAttachment[]} */
+    getAttachments() {
+        return sql.getRows(`
+                SELECT attachments.*
+                FROM attachments 
+                WHERE ownerId = ? 
+                  AND isDeleted = 0`, [this.revisionId])
+            .map(row => new BAttachment(row));
+    }
+
+    beforeSaving() {
+        super.beforeSaving();
+
+        this.utcDateModified = dateUtils.utcNowDateTime();
+    }
+
+    getPojo() {
+        return {
+            revisionId: this.revisionId,
+            noteId: this.noteId,
+            type: this.type,
+            mime: this.mime,
+            isProtected: this.isProtected,
+            title: this.title,
+            blobId: this.blobId,
+            dateLastEdited: this.dateLastEdited,
+            dateCreated: this.dateCreated,
+            utcDateLastEdited: this.utcDateLastEdited,
+            utcDateCreated: this.utcDateCreated,
+            utcDateModified: this.utcDateModified,
+            content: this.content, // used when retrieving full note revision to frontend
+            contentLength: this.contentLength
+        };
+    }
+
+    getPojoToSave() {
+        const pojo = this.getPojo();
+        delete pojo.content; // not getting persisted
+        delete pojo.contentLength; // not getting persisted
+
+        if (pojo.isProtected) {
+            if (protectedSessionService.isProtectedSessionAvailable()) {
+                pojo.title = protectedSessionService.encrypt(this.title);
+            }
+            else {
+                // updating protected note outside of protected session means we will keep original ciphertexts
+                delete pojo.title;
+            }
+        }
+
+        return pojo;
+    }
+}
+
+module.exports = BRevision;
+</code></pre>
+        </article>
+    </section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

docs/backend_api/global.html

@@ -0,0 +1,655 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Global</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Global</h1>
+
+    
+
+
+
+
+<section>
+
+<header>
+    
+        <h2></h2>
+        
+    
+</header>
+
+<article>
+    <div class="container-overview">
+    
+        
+
+        
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+        
+    
+    </div>
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+        <h3 class="subsection-title">Members</h3>
+
+        
+            
+<h4 class="name" id="api"><span class="type-signature"></span>api<span class="type-signature"> :<a href="BackendScriptApi.html">BackendScriptApi</a></span></h4>
+
+
+
+
+<div class="description">
+    An instance of the frontend api available globally.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type"><a href="BackendScriptApi.html">BackendScriptApi</a></span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="services_backend_script_api.js.html">services/backend_script_api.js</a>, <a href="services_backend_script_api.js.html#line29">line 29</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+    
+
+    
+
+    
+        <h3 class="subsection-title">Type Definitions</h3>
+
+        
+                
+<h4 class="name" id="AttributeType">AttributeType</h4>
+
+
+
+
+<div class="description">
+    There are currently only two types of attributes, labels or relations.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">"label"</span>
+|
+
+<span class="param-type">"relation"</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line11">line 11</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+            
+                
+<h4 class="name" id="NotePathRecord">NotePathRecord</h4>
+
+
+
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Object</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+    <h5 class="subsection-title">Properties:</h5>
+
+    
+
+<table class="props">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>isArchived</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">boolean</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>isInHoistedSubTree</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">boolean</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>notePath</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;string></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>isHidden</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">boolean</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line27">line 27</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+            
+                
+<h4 class="name" id="NoteType">NoteType</h4>
+
+
+
+
+<div class="description">
+    There are many different Note types, some of which are entirely opaque to the
+end user. Those types should be used only for checking against, they are
+not for direct use.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">"file"</span>
+|
+
+<span class="param-type">"image"</span>
+|
+
+<span class="param-type">"search"</span>
+|
+
+<span class="param-type">"noteMap"</span>
+|
+
+<span class="param-type">"launcher"</span>
+|
+
+<span class="param-type">"doc"</span>
+|
+
+<span class="param-type">"contentWidget"</span>
+|
+
+<span class="param-type">"text"</span>
+|
+
+<span class="param-type">"relationMap"</span>
+|
+
+<span class="param-type">"render"</span>
+|
+
+<span class="param-type">"canvas"</span>
+|
+
+<span class="param-type">"mermaid"</span>
+|
+
+<span class="param-type">"book"</span>
+|
+
+<span class="param-type">"webView"</span>
+|
+
+<span class="param-type">"code"</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line20">line 20</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+            
+                
+<h4 class="name" id="int">int</h4>
+
+
+
+
+<div class="description">
+    A whole number
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">number</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="services_backend_script_api.js.html">services/backend_script_api.js</a>, <a href="services_backend_script_api.js.html#line24">line 24</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+            
+    
+
+    
+</article>
+
+</section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>

docs/backend_api/index.html

@@ -50,7 +50,7 @@
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/backend_api/module-sql.html

@@ -1294,7 +1294,7 @@
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/backend_api/services_backend_script_api.js.html

@@ -48,6 +48,18 @@ const specialNotesService = require("./special_notes");
 const branchService = require("./branches");
 const exportService = require("./export/zip");
 
+
+/**
+ * A whole number
+ * @typedef {number} int
+ */
+
+/**
+ * An instance of the frontend api available globally.
+ * @global
+ * @var {BackendScriptApi} api
+ */
+
 /**
  * <p>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. <code>api.log(api.startNote.title);</code></p>
@@ -55,11 +67,20 @@ const exportService = require("./export/zip");
  * @constructor
  */
 function BackendScriptApi(currentNote, apiParams) {
-    /** @property {BNote} note where the script started executing */
+    /**
+     * Note where the script started executing
+     * @type {BNote}
+     */
     this.startNote = apiParams.startNote;
-    /** @property {BNote} note where the script is currently executing. Don't mix this up with the concept of active note */
+    /**
+     * Note where the script is currently executing. Don't mix this up with the concept of active note
+     * @type {BNote}
+     */
     this.currentNote = currentNote;
-    /** @property {AbstractBeccaEntity} entity whose event triggered this execution */
+    /**
+     * Entity whose event triggered this execution
+     * @type {AbstractBeccaEntity}
+     */
     this.originEntity = apiParams.originEntity;
 
     for (const key in apiParams) {
@@ -67,13 +88,20 @@ function BackendScriptApi(currentNote, apiParams) {
     }
 
     /**
-     * @property {axios} Axios library for HTTP requests. See {@link https://axios-http.com} for documentation
+     * Axios library for HTTP requests. See {@link https://axios-http.com} for documentation
+     * @type {axios} 
      * @deprecated use native (browser compatible) fetch() instead
      */
     this.axios = axios;
-    /** @property {dayjs} day.js library for date manipulation. See {@link https://day.js.org} for documentation */
+    /**
+     * day.js library for date manipulation. See {@link https://day.js.org} for documentation 
+     * @type {dayjs}
+     */
     this.dayjs = dayjs;
-    /** @property {axios} xml2js library for XML parsing. See {@link https://github.com/Leonidas-from-XIV/node-xml2js} for documentation */
+    /** 
+     * xml2js library for XML parsing. See {@link https://github.com/Leonidas-from-XIV/node-xml2js} for documentation
+     * @type {xml2js} 
+     */
     this.xml2js = xml2js;
 
     /**
@@ -234,16 +262,16 @@ function BackendScriptApi(currentNote, apiParams) {
     /**
      * @method
      *
-     * @property {object} params
+     * @param {object} params
-     * @property {string} params.parentNoteId
+     * @param {string} params.parentNoteId
-     * @property {string} params.title
+     * @param {string} params.title
-     * @property {string|buffer} params.content
+     * @param {string|Buffer} params.content
-     * @property {string} params.type - text, code, file, image, search, book, relationMap, canvas
+     * @param {NoteType} params.type - text, code, file, image, search, book, relationMap, canvas
-     * @property {string} [params.mime] - value is derived from default mimes for type
+     * @param {string} [params.mime] - value is derived from default mimes for type
-     * @property {boolean} [params.isProtected=false]
+     * @param {boolean} [params.isProtected=false]
-     * @property {boolean} [params.isExpanded=false]
+     * @param {boolean} [params.isExpanded=false]
-     * @property {string} [params.prefix='']
+     * @param {string} [params.prefix='']
-     * @property {int} [params.notePosition] - default is last existing notePosition in a parent + 10
+     * @param {int} [params.notePosition] - default is last existing notePosition in a parent + 10
      * @returns {{note: BNote, branch: BBranch}} object contains newly created entities note and branch
      */
     this.createNewNote = noteService.createNewNote;
@@ -256,14 +284,14 @@ function BackendScriptApi(currentNote, apiParams) {
      * @param {string} title
      * @param {string} [content=""]
      * @param {object} [extraOptions={}]
-     * @property {boolean} [extraOptions.json=false] - should the note be JSON
+     * @param {boolean} [extraOptions.json=false] - should the note be JSON
-     * @property {boolean} [extraOptions.isProtected=false] - should the note be protected
+     * @param {boolean} [extraOptions.isProtected=false] - should the note be protected
-     * @property {string} [extraOptions.type='text'] - note type
+     * @param {string} [extraOptions.type='text'] - note type
-     * @property {string} [extraOptions.mime='text/html'] - MIME type of the note
+     * @param {string} [extraOptions.mime='text/html'] - MIME type of the note
-     * @property {object[]} [extraOptions.attributes=[]] - attributes to be created for this note
+     * @param {object[]} [extraOptions.attributes=[]] - attributes to be created for this note
-     * @property {string} extraOptions.attributes.type - attribute type - label, relation etc.
+     * @param {AttributeType} extraOptions.attributes.type - attribute type - label, relation etc.
-     * @property {string} extraOptions.attributes.name - attribute name
+     * @param {string} extraOptions.attributes.name - attribute name
-     * @property {string} [extraOptions.attributes.value] - attribute value
+     * @param {string} [extraOptions.attributes.value] - attribute value
      * @returns {{note: BNote, branch: BBranch}} object contains newly created entities note and branch
      */
     this.createNote = (parentNoteId, title, content = "", extraOptions= {}) => {
@@ -398,10 +426,10 @@ function BackendScriptApi(currentNote, apiParams) {
      * @method
      * @param {string} parentNoteId - this note's child notes will be sorted
      * @param {object} [sortConfig]
-     * @property {string} [sortConfig.sortBy=title] - 'title', 'dateCreated', 'dateModified' or a label name
+     * @param {string} [sortConfig.sortBy=title] - 'title', 'dateCreated', 'dateModified' or a label name
      *                                See {@link https://github.com/zadam/trilium/wiki/Sorting} for details.
-     * @property {boolean} [sortConfig.reverse=false]
+     * @param {boolean} [sortConfig.reverse=false]
-     * @property {boolean} [sortConfig.foldersFirst=false]
+     * @param {boolean} [sortConfig.foldersFirst=false]
      * @returns {void}
      */
     this.sortNotes = (parentNoteId, sortConfig = {}) => treeService.sortNotes(
@@ -432,7 +460,7 @@ function BackendScriptApi(currentNote, apiParams) {
      *
      * @method
      * @param {function} func
-     * @returns {?} result of func callback
+     * @returns {any} result of func callback
      */
     this.transactional = sql.transactional;
 
@@ -460,7 +488,8 @@ function BackendScriptApi(currentNote, apiParams) {
     this.unescapeHtml = utils.unescapeHtml;
 
     /**
-     * @property {module:sql} sql
+     * sql
+     * @type {module:sql}
      */
     this.sql = sql;
 
@@ -475,18 +504,18 @@ function BackendScriptApi(currentNote, apiParams) {
      *
      * @method
      * @param {object} opts
-     * @property {string} opts.id - id of the launcher, only alphanumeric at least 6 characters long
+     * @param {string} opts.id - id of the launcher, only alphanumeric at least 6 characters long
-     * @property {string} opts.type - one of
+     * @param {"note" | "script" | "customWidget"} opts.type - one of
      *                          * "note" - activating the launcher will navigate to the target note (specified in targetNoteId param)
      *                          * "script" -  activating the launcher will execute the script (specified in scriptNoteId param)
      *                          * "customWidget" - the launcher will be rendered with a custom widget (specified in widgetNoteId param)
-     * @property {string} opts.title
+     * @param {string} opts.title
-     * @property {boolean} [opts.isVisible=false] - if true, will be created in the "Visible launchers", otherwise in "Available launchers"
+     * @param {boolean} [opts.isVisible=false] - if true, will be created in the "Visible launchers", otherwise in "Available launchers"
-     * @property {string} [opts.icon] - name of the boxicon to be used (e.g. "bx-time")
+     * @param {string} [opts.icon] - name of the boxicon to be used (e.g. "bx-time")
-     * @property {string} [opts.keyboardShortcut] - will activate the target note/script upon pressing, e.g. "ctrl+e"
+     * @param {string} [opts.keyboardShortcut] - will activate the target note/script upon pressing, e.g. "ctrl+e"
-     * @property {string} [opts.targetNoteId] - for type "note"
+     * @param {string} [opts.targetNoteId] - for type "note"
-     * @property {string} [opts.scriptNoteId] - for type "script"
+     * @param {string} [opts.scriptNoteId] - for type "script"
-     * @property {string} [opts.widgetNoteId] - for type "customWidget"
+     * @param {string} [opts.widgetNoteId] - for type "customWidget"
      * @returns {{note: BNote}}
      */
     this.createOrUpdateLauncher = opts => {
@@ -578,7 +607,7 @@ module.exports = BackendScriptApi;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/backend_api/services_sql.js.html

@@ -407,7 +407,7 @@ module.exports = {
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/frontend_api/BasicWidget.html

@@ -0,0 +1,443 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Class: BasicWidget</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Class: BasicWidget</h1>
+
+    
+
+
+
+
+<section>
+
+<header>
+    
+        <h2><span class="attribs"><span class="type-signature"></span></span>BasicWidget<span class="signature">()</span><span class="type-signature"></span></h2>
+        
+            <div class="class-description">This is the base widget for all other widgets.
+
+For information on using widgets, see the tutorial widget_basics.</div>
+        
+    
+</header>
+
+<article>
+    <div class="container-overview">
+    
+        
+
+    
+    <h2>Constructor</h2>
+    
+
+    
+    <h4 class="name" id="BasicWidget"><span class="type-signature"></span>new BasicWidget<span class="signature">()</span><span class="type-signature"></span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line9">line 9</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    
+    </div>
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+        <h3 class="subsection-title">Methods</h3>
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="cssBlock"><span class="type-signature"></span>cssBlock<span class="signature">(block)</span><span class="type-signature"> &rarr; {this}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    Accepts a string of CSS to add with the widget.
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>block</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line78">line 78</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    for chaining
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">this</span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span class="signature">()</span><span class="type-signature"> &rarr; {JQuery.&lt;HTMLElement>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    Method used for rendering the widget.
+
+Your class should override this method.
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line131">line 131</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    Your widget.
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">JQuery.&lt;HTMLElement></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+    
+
+    
+
+    
+</article>
+
+</section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
+</footer>
+

docs/frontend_api/FAttribute.html

@@ -30,8 +30,7 @@
     
         <h2><span class="attribs"><span class="type-signature"></span></span>FAttribute<span class="signature">()</span><span class="type-signature"></span></h2>
         
-            <div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair)
+            <div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair)
-and relation (representing named relationship between source and target note)</div>
 and relation (representing named relationship between source and target note)</div>
         
     
@@ -94,7 +93,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line7">line 7</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line12">line 12</a>
     </li></ul></dd>
     
@@ -194,7 +193,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line17">line 17</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line22">line 22</a>
     </li></ul></dd>
     
@@ -262,7 +261,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line10">line 10</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line15">line 15</a>
     </li></ul></dd>
     
@@ -330,7 +329,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line29">line 29</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line34">line 34</a>
     </li></ul></dd>
     
@@ -398,7 +397,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line23">line 23</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line28">line 28</a>
     </li></ul></dd>
     
@@ -466,7 +465,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line19">line 19</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line24">line 24</a>
     </li></ul></dd>
     
@@ -484,7 +483,7 @@ and relation (representing named relationship between source and target note)</d
 
 
         
-<h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"> :int</span></h4>
+            
 <h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"> :<a href="global.html#int">int</a></span></h4>
 
 
@@ -495,7 +494,7 @@ and relation (representing named relationship between source and target note)</d
     <h5>Type:</h5>
     <ul>
         <li>
-<span class="param-type">int</span>
+            
 <span class="param-type"><a href="global.html#int">int</a></span>
 
 
@@ -534,7 +533,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line27">line 27</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line32">line 32</a>
     </li></ul></dd>
     
@@ -552,7 +551,7 @@ and relation (representing named relationship between source and target note)</d
 
 
         
-<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
+            
 <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :<a href="global.html#AttributeType">AttributeType</a></span></h4>
 
 
@@ -563,7 +562,7 @@ and relation (representing named relationship between source and target note)</d
     <h5>Type:</h5>
     <ul>
         <li>
-<span class="param-type">string</span>
+            
 <span class="param-type"><a href="global.html#AttributeType">AttributeType</a></span>
 
 
@@ -602,7 +601,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line21">line 21</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line26">line 26</a>
     </li></ul></dd>
     
@@ -670,7 +669,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line25">line 25</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line30">line 30</a>
     </li></ul></dd>
     
@@ -746,7 +745,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line33">line 33</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line38">line 38</a>
     </li></ul></dd>
     
@@ -848,7 +847,7 @@ and relation (representing named relationship between source and target note)</d
 
     
     <dt class="tag-source">Source:</dt>
-        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line38">line 38</a>
+    <dd class="tag-source"><ul class="dummy"><li>
         <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line43">line 43</a>
     </li></ul></dd>
     
@@ -912,7 +911,7 @@ and relation (representing named relationship between source and target note)</d
 
 </div>
 
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
+<nav>
     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 

docs/frontend_api/FBranch.html

@@ -30,8 +30,7 @@
     
         <h2><span class="attribs"><span class="type-signature"></span></span>FBranch<span class="signature">()</span><span class="type-signature"></span></h2>
         
-            <div class="class-description">Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
+            <div class="class-description">Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
-parents.</div>
 parents.</div>
         
     
@@ -488,7 +487,7 @@ parents.</div>
 
 
         
-<h4 class="name" id="notePosition"><span class="type-signature"></span>notePosition<span class="type-signature"> :int</span></h4>
+            
 <h4 class="name" id="notePosition"><span class="type-signature"></span>notePosition<span class="type-signature"> :<a href="global.html#int">int</a></span></h4>
 
 
@@ -499,7 +498,7 @@ parents.</div>
     <h5>Type:</h5>
     <ul>
         <li>
-<span class="param-type">int</span>
+            
 <span class="param-type"><a href="global.html#int">int</a></span>
 
 
@@ -1124,7 +1123,7 @@ parents.</div>
 
 </div>
 
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
+<nav>
     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 

docs/frontend_api/FNote.html

@@ -30,6 +30,8 @@
     
         <h2><span class="attribs"><span class="type-signature"></span></span>FNote<span class="signature">(froca, row)</span><span class="type-signature"></span></h2>
         
+            <div class="class-description">Note is the main node and concept in Trilium.</div>
+        
     
 </header>
 
@@ -39,6 +41,8 @@
         
 
     
+    <h2>Constructor</h2>
+    
 
     
     <h4 class="name" id="FNote"><span class="type-signature"></span>new FNote<span class="signature">(froca, row)</span><span class="type-signature"></span></h4>
@@ -161,7 +165,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line33">line 33</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line47">line 47</a>
     </li></ul></dd>
     
 
@@ -264,7 +268,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line55">line 55</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line74">line 74</a>
     </li></ul></dd>
     
 
@@ -332,7 +336,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line38">line 38</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line57">line 57</a>
     </li></ul></dd>
     
 
@@ -400,7 +404,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line52">line 52</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line71">line 71</a>
     </li></ul></dd>
     
 
@@ -468,7 +472,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line46">line 46</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line65">line 65</a>
     </li></ul></dd>
     
 
@@ -536,7 +540,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line35">line 35</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line54">line 54</a>
     </li></ul></dd>
     
 
@@ -604,7 +608,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line66">line 66</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line85">line 85</a>
     </li></ul></dd>
     
 
@@ -676,7 +680,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line76">line 76</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line95">line 95</a>
     </li></ul></dd>
     
 
@@ -744,7 +748,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line62">line 62</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line81">line 81</a>
     </li></ul></dd>
     
 
@@ -812,7 +816,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line49">line 49</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line68">line 68</a>
     </li></ul></dd>
     
 
@@ -880,7 +884,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line44">line 44</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line63">line 63</a>
     </li></ul></dd>
     
 
@@ -948,7 +952,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line41">line 41</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line60">line 60</a>
     </li></ul></dd>
     
 
@@ -1016,7 +1020,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line64">line 64</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line83">line 83</a>
     </li></ul></dd>
     
 
@@ -1034,13 +1038,13 @@
 
         
             
-<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
+<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :<a href="global.html#NoteType">NoteType</a></span></h4>
 
 
 
 
 <div class="description">
-    one of 'text', 'code', 'file' or 'render'
+    See {@see NoteType} for info on values.
 </div>
 
 
@@ -1049,7 +1053,7 @@
     <ul>
         <li>
             
-<span class="param-type">string</span>
+<span class="param-type"><a href="global.html#NoteType">NoteType</a></span>
 
 
         </li>
@@ -1088,7 +1092,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line71">line 71</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line90">line 90</a>
     </li></ul></dd>
     
 
@@ -1168,7 +1172,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line354">line 354</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line373">line 373</a>
     </li></ul></dd>
     
 
@@ -1274,7 +1278,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line241">line 241</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line260">line 260</a>
     </li></ul></dd>
     
 
@@ -1376,7 +1380,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line232">line 232</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line251">line 251</a>
     </li></ul></dd>
     
 
@@ -1476,7 +1480,7 @@
             <td class="type">
             
                 
-<span class="param-type">string</span>
+<span class="param-type"><a href="global.html#AttributeType">AttributeType</a></span>
 
 
             
@@ -1550,7 +1554,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line617">line 617</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line636">line 636</a>
     </li></ul></dd>
     
 
@@ -1654,7 +1658,7 @@
             <td class="type">
             
                 
-<span class="param-type">string</span>
+<span class="param-type"><a href="global.html#AttributeType">AttributeType</a></span>
 
 
             
@@ -1728,7 +1732,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line639">line 639</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line658">line 658</a>
     </li></ul></dd>
     
 
@@ -1928,7 +1932,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line288">line 288</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line307">line 307</a>
     </li></ul></dd>
     
 
@@ -2107,7 +2111,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line410">line 410</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line429">line 429</a>
     </li></ul></dd>
     
 
@@ -2286,7 +2290,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line420">line 420</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line439">line 439</a>
     </li></ul></dd>
     
 
@@ -2392,7 +2396,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line864">line 864</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line883">line 883</a>
     </li></ul></dd>
     
 
@@ -2496,7 +2500,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line153">line 153</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line172">line 172</a>
     </li></ul></dd>
     
 
@@ -2600,7 +2604,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line170">line 170</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line189">line 189</a>
     </li></ul></dd>
     
 
@@ -2702,7 +2706,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line180">line 180</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line199">line 199</a>
     </li></ul></dd>
     
 
@@ -2804,7 +2808,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line222">line 222</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line241">line 241</a>
     </li></ul></dd>
     
 
@@ -2906,7 +2910,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line227">line 227</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line246">line 246</a>
     </li></ul></dd>
     
 
@@ -3057,7 +3061,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line693">line 693</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line712">line 712</a>
     </li></ul></dd>
     
 
@@ -3212,7 +3216,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line717">line 717</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line736">line 736</a>
     </li></ul></dd>
     
 
@@ -3379,7 +3383,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line503">line 503</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line522">line 522</a>
     </li></ul></dd>
     
 
@@ -3487,7 +3491,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line859">line 859</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line878">line 878</a>
     </li></ul></dd>
     
 
@@ -3589,7 +3593,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line759">line 759</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line778">line 778</a>
     </li></ul></dd>
     
 
@@ -3689,7 +3693,7 @@
             <td class="type">
             
                 
-<span class="param-type">string</span>
+<span class="param-type"><a href="global.html#AttributeType">AttributeType</a></span>
 
 
             
@@ -3763,7 +3767,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line606">line 606</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line625">line 625</a>
     </li></ul></dd>
     
 
@@ -3867,7 +3871,7 @@
             <td class="type">
             
                 
-<span class="param-type">string</span>
+<span class="param-type"><a href="global.html#AttributeType">AttributeType</a></span>
 
 
             
@@ -3941,7 +3945,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line628">line 628</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line647">line 647</a>
     </li></ul></dd>
     
 
@@ -4141,7 +4145,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line275">line 275</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line294">line 294</a>
     </li></ul></dd>
     
 
@@ -4296,7 +4300,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line687">line 687</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line706">line 706</a>
     </li></ul></dd>
     
 
@@ -4451,7 +4455,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line711">line 711</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line730">line 730</a>
     </li></ul></dd>
     
 
@@ -4618,7 +4622,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line495">line 495</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line514">line 514</a>
     </li></ul></dd>
     
 
@@ -4773,7 +4777,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line699">line 699</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line718">line 718</a>
     </li></ul></dd>
     
 
@@ -4928,7 +4932,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line723">line 723</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line742">line 742</a>
     </li></ul></dd>
     
 
@@ -5095,7 +5099,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line569">line 569</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line588">line 588</a>
     </li></ul></dd>
     
 
@@ -5201,7 +5205,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line145">line 145</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line164">line 164</a>
     </li></ul></dd>
     
 
@@ -5303,7 +5307,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line160">line 160</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line179">line 179</a>
     </li></ul></dd>
     
 
@@ -5405,7 +5409,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line188">line 188</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line207">line 207</a>
     </li></ul></dd>
     
 
@@ -5507,7 +5511,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line193">line 193</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line212">line 212</a>
     </li></ul></dd>
     
 
@@ -5658,7 +5662,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line705">line 705</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line724">line 724</a>
     </li></ul></dd>
     
 
@@ -5813,7 +5817,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line735">line 735</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line754">line 754</a>
     </li></ul></dd>
     
 
@@ -5983,7 +5987,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line745">line 745</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line764">line 764</a>
     </li></ul></dd>
     
 
@@ -6134,7 +6138,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line729">line 729</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line748">line 748</a>
     </li></ul></dd>
     
 
@@ -6301,7 +6305,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line577">line 577</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line596">line 596</a>
     </li></ul></dd>
     
 
@@ -6407,7 +6411,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line908">line 908</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line927">line 927</a>
     </li></ul></dd>
     
 
@@ -6468,7 +6472,7 @@
     
 
     
-    <h4 class="name" id="getSortedNotePathRecords"><span class="type-signature"></span>getSortedNotePathRecords<span class="signature">(hoistedNoteId<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;{isArchived: boolean, isInHoistedSubTree: boolean, isSearch: boolean, notePath: Array.&lt;string>, isHidden: boolean}>}</span></h4>
+    <h4 class="name" id="getSortedNotePathRecords"><span class="type-signature"></span>getSortedNotePathRecords<span class="signature">(hoistedNoteId<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="global.html#NotePathRecord">NotePathRecord</a>>}</span></h4>
     
 
     
@@ -6585,7 +6589,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line376">line 376</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line395">line 395</a>
     </li></ul></dd>
     
 
@@ -6621,7 +6625,7 @@
     </dt>
     <dd>
         
-<span class="param-type">Array.&lt;{isArchived: boolean, isInHoistedSubTree: boolean, isSearch: boolean, notePath: Array.&lt;string>, isHidden: boolean}></span>
+<span class="param-type">Array.&lt;<a href="global.html#NotePathRecord">NotePathRecord</a>></span>
 
 
     </dd>
@@ -6691,7 +6695,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line849">line 849</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line868">line 868</a>
     </li></ul></dd>
     
 
@@ -6797,7 +6801,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line839">line 839</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line858">line 858</a>
     </li></ul></dd>
     
 
@@ -6897,7 +6901,7 @@
             <td class="type">
             
                 
-<span class="param-type">string</span>
+<span class="param-type"><a href="global.html#AttributeType">AttributeType</a></span>
 
 
             
@@ -6971,7 +6975,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line586">line 586</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line605">line 605</a>
     </li></ul></dd>
     
 
@@ -7077,7 +7081,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line175">line 175</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line194">line 194</a>
     </li></ul></dd>
     
 
@@ -7228,7 +7232,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line655">line 655</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line674">line 674</a>
     </li></ul></dd>
     
 
@@ -7332,7 +7336,7 @@
             <td class="type">
             
                 
-<span class="param-type">string</span>
+<span class="param-type"><a href="global.html#AttributeType">AttributeType</a></span>
 
 
             
@@ -7406,7 +7410,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line597">line 597</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line616">line 616</a>
     </li></ul></dd>
     
 
@@ -7561,7 +7565,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line649">line 649</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line668">line 668</a>
     </li></ul></dd>
     
 
@@ -7716,7 +7720,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line675">line 675</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line694">line 694</a>
     </li></ul></dd>
     
 
@@ -7871,7 +7875,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line681">line 681</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line700">line 700</a>
     </li></ul></dd>
     
 
@@ -7979,7 +7983,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line832">line 832</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line851">line 851</a>
     </li></ul></dd>
     
 
@@ -8063,7 +8067,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line429">line 429</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line448">line 448</a>
     </li></ul></dd>
     
 
@@ -8157,7 +8161,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line903">line 903</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line922">line 922</a>
     </li></ul></dd>
     
 
@@ -8263,7 +8267,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line895">line 895</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line914">line 914</a>
     </li></ul></dd>
     
 
@@ -8369,7 +8373,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line118">line 118</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line137">line 137</a>
     </li></ul></dd>
     
 
@@ -8520,7 +8524,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line661">line 661</a>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line680">line 680</a>
     </li></ul></dd>
     
 
@@ -8588,7 +8592,7 @@
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/frontend_api/entities_fattachment.js.html

@@ -0,0 +1,102 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: entities/fattachment.js</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Source: entities/fattachment.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/**
+ * Attachment is a file directly tied into a note without
+ * being a hidden child.
+ */
+class FAttachment {
+    constructor(froca, row) {
+        /** @type {Froca} */
+        this.froca = froca;
+
+        this.update(row);
+    }
+
+    update(row) {
+        /** @type {string} */
+        this.attachmentId = row.attachmentId;
+        /** @type {string} */
+        this.ownerId = row.ownerId;
+        /** @type {string} */
+        this.role = row.role;
+        /** @type {string} */
+        this.mime = row.mime;
+        /** @type {string} */
+        this.title = row.title;
+        /** @type {string} */
+        this.dateModified = row.dateModified;
+        /** @type {string} */
+        this.utcDateModified = row.utcDateModified;
+        /** @type {string} */
+        this.utcDateScheduledForErasureSince = row.utcDateScheduledForErasureSince;
+
+        /**
+         * optionally added to the entity 
+         * @type {int}
+         */
+        this.contentLength = row.contentLength;
+
+        this.froca.attachments[this.attachmentId] = this;
+    }
+
+    /** @returns {FNote} */
+    getNote() {
+        return this.froca.notes[this.ownerId];
+    }
+
+    /** @return {FBlob} */
+    async getBlob() {
+        return await this.froca.getBlob('attachments', this.attachmentId);
+    }
+}
+
+export default FAttachment;
+</code></pre>
+        </article>
+    </section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

docs/frontend_api/entities_fattribute.js.html

@@ -28,6 +28,11 @@
         <article>
             <pre class="prettyprint source linenums"><code>import promotedAttributeDefinitionParser from '../services/promoted_attribute_definition_parser.js';
 
+/**
+ * There are currently only two types of attributes, labels or relations.
+ * @typedef {"label" | "relation"} AttributeType
+ */
+
 /**
  * Attribute is an abstract concept which has two real uses - label (key - value pair)
  * and relation (representing named relationship between source and target note)
@@ -45,7 +50,7 @@ class FAttribute {
         this.attributeId = row.attributeId;
         /** @type {string} */
         this.noteId = row.noteId;
-        /** @type {string} */
+        /** @type {AttributeType} */
         this.type = row.type;
         /** @type {string} */
         this.name = row.name;
@@ -116,7 +121,7 @@ export default FAttribute;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/frontend_api/entities_fblob.js.html

@@ -0,0 +1,69 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: entities/fblob.js</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Source: entities/fblob.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>export default class FBlob {
+    constructor(row) {
+        /** @type {string} */
+        this.blobId = row.blobId;
+
+        /**
+         * can either contain the whole content (in e.g. string notes), only part (large text notes) or nothing at all (binary notes, images)
+         * @type {string}
+         */
+        this.content = row.content;
+        this.contentLength = row.contentLength;
+
+        /** @type {string} */
+        this.dateModified = row.dateModified;
+        /** @type {string} */
+        this.utcDateModified = row.utcDateModified;
+    }
+}
+</code></pre>
+        </article>
+    </section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

docs/frontend_api/entities_fbranch.js.html

@@ -100,7 +100,7 @@ export default FBranch;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/frontend_api/entities_fnote.js.html

@@ -53,6 +53,25 @@ const NOTE_TYPE_ICONS = {
     "contentWidget": "bx bxs-widget"
 };
 
+/**
+ * There are many different Note types, some of which are entirely opaque to the
+ * end user. Those types should be used only for checking against, they are
+ * not for direct use.
+ * @typedef {"file" | "image" | "search" | "noteMap" | "launcher" | "doc" | "contentWidget" | "text" | "relationMap" | "render" | "canvas" | "mermaid" | "book" | "webView" | "code"} NoteType
+ */
+
+/**
+ * @typedef {Object} NotePathRecord
+ * @property {boolean} isArchived
+ * @property {boolean} isInHoistedSubTree
+ * @property {boolean} isSearch
+ * @property {Array<string>} notePath
+ * @property {boolean} isHidden
+ */
+
+/**
+ * Note is the main node and concept in Trilium.
+ */
 class FNote {
     /**
      * @param {Froca} froca
@@ -93,8 +112,8 @@ class FNote {
         /** @type {boolean} */
         this.isProtected = !!row.isProtected;
         /**
-         * one of 'text', 'code', 'file' or 'render'
+         * See {@see NoteType} for info on values.
-         * @type {string}
+         * @type {NoteType}
          */
         this.type = row.type;
         /**
@@ -399,7 +418,7 @@ class FNote {
 
     /**
      * @param {string} [hoistedNoteId='root']
-     * @return {Array<{isArchived: boolean, isInHoistedSubTree: boolean, isSearch: boolean, notePath: Array<string>, isHidden: boolean}>}
+     * @return {Array<NotePathRecord>}
      */
     getSortedNotePathRecords(hoistedNoteId = 'root') {
         const isHoistedRoot = hoistedNoteId === 'root';
@@ -478,7 +497,7 @@ class FNote {
 
     /**
      * @param {FAttribute[]} attributes
-     * @param {string} type
+     * @param {AttributeType} type
      * @param {string} name
      * @return {FAttribute[]}
      * @private
@@ -607,7 +626,7 @@ class FNote {
     }
 
     /**
-     * @param {string} type - attribute type (label, relation, etc.)
+     * @param {AttributeType} type - attribute type (label, relation, etc.)
      * @param {string} name - attribute name
      * @returns {boolean} true if note has an attribute with given type and name (including inherited)
      */
@@ -618,7 +637,7 @@ class FNote {
     }
 
     /**
-     * @param {string} type - attribute type (label, relation, etc.)
+     * @param {AttributeType} type - attribute type (label, relation, etc.)
      * @param {string} name - attribute name
      * @returns {boolean} true if note has an attribute with given type and name (including inherited)
      */
@@ -627,7 +646,7 @@ class FNote {
     }
 
     /**
-     * @param {string} type - attribute type (label, relation, etc.)
+     * @param {AttributeType} type - attribute type (label, relation, etc.)
      * @param {string} name - attribute name
      * @returns {FAttribute} attribute of the given type and name. If there are more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
      */
@@ -638,7 +657,7 @@ class FNote {
     }
 
     /**
-     * @param {string} type - attribute type (label, relation, etc.)
+     * @param {AttributeType} type - attribute type (label, relation, etc.)
      * @param {string} name - attribute name
      * @returns {FAttribute} attribute of the given type and name. If there are more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
      */
@@ -649,7 +668,7 @@ class FNote {
     }
 
     /**
-     * @param {string} type - attribute type (label, relation, etc.)
+     * @param {AttributeType} type - attribute type (label, relation, etc.)
      * @param {string} name - attribute name
      * @returns {string} attribute value of the given type and name or null if no such attribute exists.
      */
@@ -660,7 +679,7 @@ class FNote {
     }
 
     /**
-     * @param {string} type - attribute type (label, relation, etc.)
+     * @param {AttributeType} type - attribute type (label, relation, etc.)
      * @param {string} name - attribute name
      * @returns {string} attribute value of the given type and name or null if no such attribute exists.
      */
@@ -1012,7 +1031,7 @@ export default FNote;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/frontend_api/global.html

@@ -0,0 +1,678 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Global</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Global</h1>
+
+    
+
+
+
+
+<section>
+
+<header>
+    
+        <h2></h2>
+        
+    
+</header>
+
+<article>
+    <div class="container-overview">
+    
+        
+
+        
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+        
+    
+    </div>
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+        <h3 class="subsection-title">Members</h3>
+
+        
+            
+<h4 class="name" id="api"><span class="type-signature"></span>api<span class="type-signature"> :<a href="FrontendScriptApi.html">FrontendScriptApi</a></span></h4>
+
+
+
+
+<div class="description">
+    An instance of the frontend api available globally.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type"><a href="FrontendScriptApi.html">FrontendScriptApi</a></span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line24">line 24</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+    
+
+    
+
+    
+        <h3 class="subsection-title">Type Definitions</h3>
+
+        
+                
+<h4 class="name" id="AttributeType">AttributeType</h4>
+
+
+
+
+<div class="description">
+    There are currently only two types of attributes, labels or relations.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">"label"</span>
+|
+
+<span class="param-type">"relation"</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line3">line 3</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+            
+                
+<h4 class="name" id="NotePathRecord">NotePathRecord</h4>
+
+
+
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Object</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+    <h5 class="subsection-title">Properties:</h5>
+
+    
+
+<table class="props">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>isArchived</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">boolean</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>isInHoistedSubTree</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">boolean</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>isSearch</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">boolean</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>notePath</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;string></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>isHidden</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">boolean</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line35">line 35</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+            
+                
+<h4 class="name" id="NoteType">NoteType</h4>
+
+
+
+
+<div class="description">
+    There are many different Note types, some of which are entirely opaque to the
+end user. Those types should be used only for checking against, they are
+not for direct use.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">"file"</span>
+|
+
+<span class="param-type">"image"</span>
+|
+
+<span class="param-type">"search"</span>
+|
+
+<span class="param-type">"noteMap"</span>
+|
+
+<span class="param-type">"launcher"</span>
+|
+
+<span class="param-type">"doc"</span>
+|
+
+<span class="param-type">"contentWidget"</span>
+|
+
+<span class="param-type">"text"</span>
+|
+
+<span class="param-type">"relationMap"</span>
+|
+
+<span class="param-type">"render"</span>
+|
+
+<span class="param-type">"canvas"</span>
+|
+
+<span class="param-type">"mermaid"</span>
+|
+
+<span class="param-type">"book"</span>
+|
+
+<span class="param-type">"webView"</span>
+|
+
+<span class="param-type">"code"</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line28">line 28</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+            
+                
+<h4 class="name" id="int">int</h4>
+
+
+
+
+<div class="description">
+    A whole number
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">number</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line19">line 19</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+            
+    
+
+    
+</article>
+
+</section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>

docs/frontend_api/index.html

@@ -50,7 +50,7 @@
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/frontend_api/services_frontend_script_api.js.html

@@ -43,6 +43,18 @@ import BasicWidget from "../widgets/basic_widget.js";
 import SpacedUpdate from "./spaced_update.js";
 import shortcutService from "./shortcuts.js";
 
+
+/**
+ * A whole number
+ * @typedef {number} int
+ */
+
+/**
+ * An instance of the frontend api available globally.
+ * @global
+ * @var {FrontendScriptApi} api
+ */
+
 /**
  * <p>This is the main frontend API interface for scripts. All the properties and methods are published in the "api" object
  * available in the JS frontend notes. You can use e.g. <code>api.showMessage(api.startNote.title);</code></p>
@@ -50,26 +62,44 @@ import shortcutService from "./shortcuts.js";
  * @constructor
  */
 function FrontendScriptApi(startNote, currentNote, originEntity = null, $container = null) {
-    /** @property {jQuery} container of all the rendered script content */
+    /** 
+     * Container of all the rendered script content
+     * @type {jQuery}
+     * */
     this.$container = $container;
 
-    /** @property {object} note where the script started executing */
+    /**
+     * Note where the script started executing
+     * @type {FNote}
+     */
     this.startNote = startNote;
-    /** @property {object} note where the script is currently executing */
+
+    /**
+     * Note where the script is currently executing
+     * @type {FNote}
+     */
     this.currentNote = currentNote;
-    /** @property {object|null} entity whose event triggered this execution */
+    /** 
+     * Entity whose event triggered this execution
+     * @type {object|null}
+     */
     this.originEntity = originEntity;
 
-    /** @property {dayjs} day.js library for date manipulation. See {@link https://day.js.org} for documentation */
+    /**
+     * day.js library for date manipulation.
+     * See {@link https://day.js.org} for documentation
+     * @see https://day.js.org
+     * @type {dayjs}
+     */
     this.dayjs = dayjs;
 
-    /** @property {RightPanelWidget} */
+    /** @type {RightPanelWidget} */
     this.RightPanelWidget = RightPanelWidget;
 
-    /** @property {NoteContextAwareWidget} */
+    /** @type {NoteContextAwareWidget} */
     this.NoteContextAwareWidget = NoteContextAwareWidget;
 
-    /** @property {BasicWidget} */
+    /** @type {BasicWidget} */
     this.BasicWidget = BasicWidget;
 
     /**
@@ -142,12 +172,12 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      * @deprecated you can now create/modify launchers in the top-left Menu -> Configure Launchbar
      *             for special needs there's also backend API's createOrUpdateLauncher()
      * @param {object} opts
-     * @property {string} [opts.id] - id of the button, used to identify the old instances of this button to be replaced
+     * @param {string} opts.title
+     * @param {function} opts.action - callback handling the click on the button
+     * @param {string} [opts.id] - id of the button, used to identify the old instances of this button to be replaced
      *                          ID is optional because of BC, but not specifying it is deprecated. ID can be alphanumeric only.
-     * @property {string} opts.title
+     * @param {string} [opts.icon] - name of the boxicon to be used (e.g. "time" for "bx-time" icon)
-     * @property {string} [opts.icon] - name of the boxicon to be used (e.g. "time" for "bx-time" icon)
+     * @param {string} [opts.shortcut] - keyboard shortcut for the button, e.g. "alt+t"
-     * @property {function} opts.action - callback handling the click on the button
-     * @property {string} [opts.shortcut] - keyboard shortcut for the button, e.g. "alt+t"
      */
     this.addButtonToToolbar = async opts => {
         console.warn("api.addButtonToToolbar() has been deprecated since v0.58 and may be removed in the future. Use  Menu -> Configure Launchbar to create/update launchers instead.");
@@ -178,9 +208,9 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      * Internally this serializes the anonymous function into string and sends it to backend via AJAX.
      *
      * @method
-     * @param {string} script - script to be executed on the backend
+     * @param {string|Function} script - script to be executed on the backend
-     * @param {Array.<?>} params - list of parameters to the anonymous function to be sent to backend
+     * @param {Array<any>} params - list of parameters to the anonymous function to be sent to backend
-     * @returns {Promise<*>} return value of the executed function on the backend
+     * @returns {Promise<any>} return value of the executed function on the backend
      */
     this.runOnBackend = async (script, params = []) => {
         if (typeof script === "function") {
@@ -328,7 +358,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      * @param {boolean} [params.showTooltip=true] - enable/disable tooltip on the link
      * @param {boolean} [params.showNotePath=false] - show also whole note's path as part of the link
      * @param {boolean} [params.showNoteIcon=false] - show also note icon before the title
-     * @param {string} [params.title=] - custom link tile with note's title as default
+     * @param {string} [params.title] - custom link tile with note's title as default
      */
     this.createLink = linkService.createLink;
 
@@ -569,7 +599,7 @@ export default FrontendScriptApi;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
 </nav>
 
 <br class="clear">

docs/frontend_api/widgets_basic_widget.js.html

@@ -0,0 +1,230 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: widgets/basic_widget.js</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Source: widgets/basic_widget.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import Component from "../components/component.js";
+
+
+/**
+ * This is the base widget for all other widgets.
+ * 
+ * For information on using widgets, see the tutorial {@tutorial widget_basics}.
+ */
+class BasicWidget extends Component {
+    constructor() {
+        super();
+
+        this.attrs = {
+            style: ''
+        };
+        this.classes = [];
+
+        this.children = [];
+        this.childPositionCounter = 10;
+    }
+
+    child(...components) {
+        if (!components) {
+            return this;
+        }
+
+        super.child(...components);
+
+        for (const component of components) {
+            if (component.position === undefined) {
+                component.position = this.childPositionCounter;
+                this.childPositionCounter += 10;
+            }
+        }
+
+        this.children.sort((a, b) => a.position - b.position &lt; 0 ? -1 : 1);
+
+        return this;
+    }
+
+    id(id) {
+        this.attrs.id = id;
+        return this;
+    }
+
+    class(className) {
+        this.classes.push(className);
+        return this;
+    }
+
+    css(name, value) {
+        this.attrs.style += `${name}: ${value};`;
+        return this;
+    }
+
+    contentSized() {
+        this.css("contain", "none");
+
+        return this;
+    }
+
+    collapsible() {
+        this.css('min-height', '0');
+        this.css('min-width', '0');
+        return this;
+    }
+
+    filling() {
+        this.css('flex-grow', '1');
+        return this;
+    }
+
+    /**
+     * Accepts a string of CSS to add with the widget.
+     * @param {string} block 
+     * @returns {this} for chaining
+     */
+    cssBlock(block) {
+        this.cssEl = block;
+        return this;
+    }
+
+    render() {
+        this.doRender();
+
+        this.$widget.attr('data-component-id', this.componentId);
+        this.$widget.addClass('component')
+            .prop('component', this);
+
+        if (!this.isEnabled()) {
+            this.toggleInt(false);
+        }
+
+        if (this.cssEl) {
+            const css = this.cssEl.trim().startsWith('&lt;style>') ? this.cssEl : `&lt;style>${this.cssEl}&lt;/style>`;
+
+            this.$widget.append(css);
+        }
+
+        for (const key in this.attrs) {
+            if (key === 'style') {
+                if (this.attrs[key]) {
+                    let style = this.$widget.attr('style');
+                    style = style ? `${style}; ${this.attrs[key]}` : this.attrs[key];
+
+                    this.$widget.attr(key, style);
+                }
+            }
+            else {
+                this.$widget.attr(key, this.attrs[key]);
+            }
+        }
+
+        for (const className of this.classes) {
+            this.$widget.addClass(className);
+        }
+
+        return this.$widget;
+    }
+
+    isEnabled() {
+        return true;
+    }
+
+    /**
+     * Method used for rendering the widget.
+     * 
+     * Your class should override this method.
+     * @returns {JQuery&lt;HTMLElement>} Your widget.
+     */
+    doRender() {}
+
+    toggleInt(show) {
+        this.$widget.toggleClass('hidden-int', !show);
+    }
+
+    isHiddenInt() {
+        return this.$widget.hasClass('hidden-int');
+    }
+
+    toggleExt(show) {
+        this.$widget.toggleClass('hidden-ext', !show);
+    }
+
+    isHiddenExt() {
+        return this.$widget.hasClass('hidden-ext');
+    }
+
+    canBeShown() {
+        return !this.isHiddenInt() &amp;&amp; !this.isHiddenExt();
+    }
+
+    isVisible() {
+        return this.$widget.is(":visible");
+    }
+
+    getPosition() {
+        return this.position;
+    }
+
+    remove() {
+        if (this.$widget) {
+            this.$widget.remove();
+        }
+    }
+
+    getClosestNtxId() {
+        if (this.$widget) {
+            return this.$widget.closest("[data-ntx-id]").attr("data-ntx-id");
+        }
+        else {
+            return null;
+        }
+    }
+
+    cleanup() {}
+}
+
+export default BasicWidget;
+</code></pre>
+        </article>
+    </section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

docs/frontend_api/widgets_note_context_aware_widget.js.html

@@ -0,0 +1,173 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: widgets/note_context_aware_widget.js</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Source: widgets/note_context_aware_widget.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import BasicWidget from "./basic_widget.js";
+import appContext from "../components/app_context.js";
+
+/**
+ * This widget allows for changing and updating depending on the active note.
+ * @extends {BasicWidget}
+ */
+class NoteContextAwareWidget extends BasicWidget {
+    isNoteContext(ntxId) {
+        if (Array.isArray(ntxId)) {
+            return this.noteContext &amp;&amp; ntxId.includes(this.noteContext.ntxId);
+        }
+        else {
+            return this.noteContext &amp;&amp; this.noteContext.ntxId === ntxId;
+        }
+    }
+
+    isActiveNoteContext() {
+        return appContext.tabManager.getActiveContext() === this.noteContext;
+    }
+
+    isNote(noteId) {
+        return this.noteId === noteId;
+    }
+
+    /** @returns {FNote|undefined} */
+    get note() {
+        return this.noteContext?.note;
+    }
+
+    /** @returns {string|undefined} */
+    get noteId() {
+        return this.note?.noteId;
+    }
+
+    /** @returns {string|undefined} */
+    get notePath() {
+        return this.noteContext?.notePath;
+    }
+
+    /** @returns {string} */
+    get hoistedNoteId() {
+        return this.noteContext?.hoistedNoteId;
+    }
+
+    get ntxId() {
+        return this.noteContext?.ntxId;
+    }
+
+    /**
+     * @returns {boolean} true when an active note exists
+     */
+    isEnabled() {
+        return !!this.note;
+    }
+
+    async refresh() {
+        if (this.isEnabled()) {
+            this.toggleInt(true);
+            await this.refreshWithNote(this.note);
+        }
+        else {
+            this.toggleInt(false);
+        }
+    }
+
+    /**
+     * Override this method to be able to refresh your
+     * widget with each note.
+     * @param {FNote} note
+     * @returns {Promise&lt;void>}
+     */
+    async refreshWithNote(note) {}
+
+    async noteSwitchedEvent({noteContext, notePath}) {
+        // if notePath does not match, then the noteContext has been switched to another note in the meantime
+        if (noteContext.notePath === notePath) {
+            await this.noteSwitched();
+        }
+    }
+
+    async noteSwitched() {
+        await this.refresh();
+    }
+
+    async activeContextChangedEvent({noteContext}) {
+        this.noteContext = noteContext;
+
+        await this.activeContextChanged();
+    }
+
+    async activeContextChanged() {
+        await this.refresh();
+    }
+
+    // when note is both switched and activated, this should not produce a double refresh
+    async noteSwitchedAndActivatedEvent({noteContext, notePath}) {
+        this.noteContext = noteContext;
+
+        // if notePath does not match, then the noteContext has been switched to another note in the meantime
+        if (this.notePath === notePath) {
+            await this.refresh();
+        }
+    }
+
+    setNoteContextEvent({noteContext}) {
+        /** @var {NoteContext} */
+        this.noteContext = noteContext;
+    }
+
+    async noteTypeMimeChangedEvent({noteId}) {
+        if (this.isNote(noteId)) {
+            await this.refresh();
+        }
+    }
+
+    async frocaReloadedEvent() {
+        await this.refresh();
+    }
+}
+
+export default NoteContextAwareWidget;
+</code></pre>
+        </article>
+    </section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

docs/frontend_api/widgets_right_panel_widget.js.html

@@ -0,0 +1,100 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: widgets/right_panel_widget.js</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Source: widgets/right_panel_widget.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import NoteContextAwareWidget from "./note_context_aware_widget.js";
+
+const WIDGET_TPL = `
+&lt;div class="card widget">
+    &lt;div class="card-header">&lt;/div>
+
+    &lt;div id="[to be set]" class="body-wrapper">
+        &lt;div class="card-body">&lt;/div>
+    &lt;/div>
+&lt;/div>`;
+
+/**
+ * This widget manages rendering panels in the right-hand pane.
+ * @extends {NoteContextAwareWidget}
+ */
+class RightPanelWidget extends NoteContextAwareWidget {
+    /** Title to show in the panel. */
+    get widgetTitle() { return "Untitled widget"; }
+
+    get help() { return {}; }
+
+    /**
+     * Do not override this method unless you know what you're doing.
+     */
+    doRender() {
+        this.$widget = $(WIDGET_TPL);
+        this.contentSized();
+        this.$widget.find('[data-target]').attr('data-target', `#${this.componentId}`);
+
+        this.$bodyWrapper = this.$widget.find('.body-wrapper');
+        this.$bodyWrapper.attr('id', this.componentId); // for toggle to work we need id
+
+        this.$body = this.$bodyWrapper.find('.card-body');
+
+        this.$title = this.$widget.find('.card-header');
+        this.$title.text(this.widgetTitle);
+
+        this.initialized = this.doRenderBody();
+    }
+
+    /**
+     * Method used for rendering the body of the widget.
+     * 
+     * Your class should override this method.
+     * @returns {JQuery&lt;HTMLElement>} The body of your widget.
+     */
+    async doRenderBody() {}
+}
+
+export default RightPanelWidget;</code></pre>
+        </article>
+    </section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>