<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: Note</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: Note</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>Note<span class="signature">(row)</span><span class="type-signature"></span></h2> <div class="class-description">This represents a Note which is a central object in the Trilium Notes project.</div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="Note"><span class="type-signature"></span>new Note<span class="signature">(row)</span><span class="type-signature"></span></h4> <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>row</code></td> <td class="type"> </td> <td class="description last">object containing database row from "notes" table</td> </tr> </tbody> </table> <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>noteId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">primary key</td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">one of "text", "code", "file" or "render"</td> </tr> <tr> <td class="name"><code>mime</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">MIME type, e.g. "text/html"</td> </tr> <tr> <td class="name"><code>title</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">note title</td> </tr> <tr> <td class="name"><code>contentLength</code></td> <td class="type"> <span class="param-type">int</span> </td> <td class="description last">length of content</td> </tr> <tr> <td class="name"><code>isProtected</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last">true if note is protected</td> </tr> <tr> <td class="name"><code>isDeleted</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last">true if note is deleted</td> </tr> <tr> <td class="name"><code>isErased</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last">true if note's content is erased after it has been deleted</td> </tr> <tr> <td class="name"><code>dateCreated</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">local date time (with offset)</td> </tr> <tr> <td class="name"><code>dateModified</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">local date time (with offset)</td> </tr> <tr> <td class="name"><code>utcDateCreated</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>utcDateModified</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="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line43">line 43</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Extends</h3> <ul> <li><a href="Entity.html">Entity</a></li> </ul> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="addAttribute"><span class="type-signature">(async) </span>addAttribute<span class="signature">()</span><span class="type-signature"> → {Promise.<<a href="Attribute.html">Attribute</a>>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line540">line 540</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<<a href="Attribute.html">Attribute</a>></span> </dd> </dl> <h4 class="name" id="getAllNotePaths"><span class="type-signature">(async) </span>getAllNotePaths<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<Array.<string>>>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line868">line 868</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> - array of notePaths (each represented by array of noteIds constituting the particular note path) </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<Array.<string>>></span> </dd> </dl> <h4 class="name" id="getAttribute"><span class="type-signature">(async) </span>getAttribute<span class="signature">(type, name)</span><span class="type-signature"> → {Promise.<<a href="Attribute.html">Attribute</a>>}</span></h4> <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>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">attribute type (label, relation, etc.)</td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">attribute name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line436">line 436</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<<a href="Attribute.html">Attribute</a>></span> </dd> </dl> <h4 class="name" id="getAttributes"><span class="type-signature">(async) </span>getAttributes<span class="signature">(type<span class="signature-attributes">opt</span>, name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<<a href="Attribute.html">Attribute</a>>>}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">(optional) attribute type to filter</td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">(optional) attribute name to filter</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line254">line 254</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> all note's attributes, including inherited ones </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Attribute.html">Attribute</a>>></span> </dd> </dl> <h4 class="name" id="getAttributeValue"><span class="type-signature">(async) </span>getAttributeValue<span class="signature">(type, name)</span><span class="type-signature"> → {Promise.<(string|null)>}</span></h4> <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>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">attribute type (label, relation, etc.)</td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">attribute name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line447">line 447</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> attribute value of given type and name or null if no such attribute exists. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<(string|null)></span> </dd> </dl> <h4 class="name" id="getBranches"><span class="type-signature">(async) </span>getBranches<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="Branch.html">Branch</a>>>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line814">line 814</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Branch.html">Branch</a>>></span> </dd> </dl> <h4 class="name" id="getChildBranches"><span class="type-signature">(async) </span>getChildBranches<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="Branch.html">Branch</a>>>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line842">line 842</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> child branches of this note </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Branch.html">Branch</a>>></span> </dd> </dl> <h4 class="name" id="getChildNotes"><span class="type-signature">(async) </span>getChildNotes<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="Note.html">Note</a>>>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line828">line 828</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> child notes of this note </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Note.html">Note</a>>></span> </dd> </dl> <h4 class="name" id="getContent"><span class="type-signature">(async) </span>getContent<span class="signature">()</span><span class="type-signature"> → {Promise.<*>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line74">line 74</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<*></span> </dd> </dl> <h4 class="name" id="getDescendantNoteIds"><span class="type-signature">(async) </span>getDescendantNoteIds<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<string>>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line714">line 714</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> return list of all descendant noteIds of this note. Returning just noteIds because number of notes can be huge. Includes also this note's noteId </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<string>></span> </dd> </dl> <h4 class="name" id="getDescendantNotesWithAttribute"><span class="type-signature">(async) </span>getDescendantNotesWithAttribute<span class="signature">(type, name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<<a href="Note.html">Note</a>>>}</span></h4> <div class="description"> Finds descendant notes with given attribute name and value. Only own attributes are considered, not inherited ones </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">attribute type (label, relation, etc.)</td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">attribute name</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">attribute value</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line737">line 737</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Note.html">Note</a>>></span> </dd> </dl> <h4 class="name" id="getDescendantNotesWithLabel"><span class="type-signature">(async) </span>getDescendantNotesWithLabel<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<<a href="Note.html">Note</a>>>}</span></h4> <div class="description"> Finds descendant notes with given label name and value. Only own labels are considered, not inherited ones </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">label name</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">label value</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line775">line 775</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Note.html">Note</a>>></span> </dd> </dl> <h4 class="name" id="getDescendantNotesWithRelation"><span class="type-signature">(async) </span>getDescendantNotesWithRelation<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<<a href="Note.html">Note</a>>>}</span></h4> <div class="description"> Finds descendant notes with given relation name and value. Only own relations are considered, not inherited ones </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">relation name</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">relation value</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line784">line 784</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Note.html">Note</a>>></span> </dd> </dl> <h4 class="name" id="getJsonContent"><span class="type-signature">(async) </span>getJsonContent<span class="signature">()</span><span class="type-signature"> → {Promise.<*>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line109">line 109</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<*></span> </dd> </dl> <h4 class="name" id="getLabel"><span class="type-signature">(async) </span>getLabel<span class="signature">(name)</span><span class="type-signature"> → {Promise.<(<a href="Attribute.html">Attribute</a>|null)>}</span></h4> <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>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">label name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line591">line 591</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> label if it exists, null otherwise </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<(<a href="Attribute.html">Attribute</a>|null)></span> </dd> </dl> <h4 class="name" id="getLabelDefinitions"><span class="type-signature">(async) </span>getLabelDefinitions<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<<a href="Attribute.html">Attribute</a>>>}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">label name to filter</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line293">line 293</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> all note's label definitions, including inherited ones </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Attribute.html">Attribute</a>>></span> </dd> </dl> <h4 class="name" id="getLabels"><span class="type-signature">(async) </span>getLabels<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<<a href="Attribute.html">Attribute</a>>>}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">label name to filter</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line277">line 277</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> all note's labels (attributes with type label), including inherited ones </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Attribute.html">Attribute</a>>></span> </dd> </dl> <h4 class="name" id="getLabelValue"><span class="type-signature">(async) </span>getLabelValue<span class="signature">(name)</span><span class="type-signature"> → {Promise.<(string|null)>}</span></h4> <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>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">label name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line615">line 615</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> label value if label exists, null otherwise </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<(string|null)></span> </dd> </dl> <h4 class="name" id="getLinks"><span class="type-signature">(async) </span>getLinks<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="Attribute.html">Attribute</a>>>}</span></h4> <div class="description"> Get list of links coming out of this note. </div> <dl class="details"> <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>- not intended for general use</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line801">line 801</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Attribute.html">Attribute</a>>></span> </dd> </dl> <h4 class="name" id="getOwnedAttribute"><span class="type-signature">(async) </span>getOwnedAttribute<span class="signature">()</span><span class="type-signature"> → {Promise.<<a href="Attribute.html">Attribute</a>>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line236">line 236</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> attribute belonging to this specific note (excludes inherited attributes) This method can be significantly faster than the getAttribute() </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<<a href="Attribute.html">Attribute</a>></span> </dd> </dl> <h4 class="name" id="getOwnedAttributes"><span class="type-signature">(async) </span>getOwnedAttributes<span class="signature">(type<span class="signature-attributes">opt</span>, name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<<a href="Attribute.html">Attribute</a>>>}</span></h4> <div class="description"> This method is a faster variant of getAttributes() which looks for only owned attributes. Use when inheritance is not needed and/or in batch/performance sensitive operations. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">(optional) attribute type to filter</td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">(optional) attribute name to filter</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line212">line 212</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> note's "owned" attributes - excluding inherited ones </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Attribute.html">Attribute</a>>></span> </dd> </dl> <h4 class="name" id="getOwnedAttributeValue"><span class="type-signature">(async) </span>getOwnedAttributeValue<span class="signature">(type, name)</span><span class="type-signature"> → {Promise.<(string|null)>}</span></h4> <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>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">attribute type (label, relation, etc.)</td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">attribute name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line458">line 458</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> attribute value of given type and name or null if no such attribute exists. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<(string|null)></span> </dd> </dl> <h4 class="name" id="getOwnedLabel"><span class="type-signature">(async) </span>getOwnedLabel<span class="signature">(name)</span><span class="type-signature"> → {Promise.<(<a href="Attribute.html">Attribute</a>|null)>}</span></h4> <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>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">label name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line597">line 597</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> label if it exists, null otherwise </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<(<a href="Attribute.html">Attribute</a>|null)></span> </dd> </dl> <h4 class="name" id="getOwnedLabels"><span class="type-signature">(async) </span>getOwnedLabels<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<<a href="Attribute.html">Attribute</a>>>}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">label name to filter</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line285">line 285</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> all note's labels (attributes with type label), excluding inherited ones </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Attribute.html">Attribute</a>>></span> </dd> </dl> <h4 class="name" id="getOwnedLabelValue"><span class="type-signature">(async) </span>getOwnedLabelValue<span class="signature">(name)</span><span class="type-signature"> → {Promise.<(string|null)>}</span></h4> <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>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">label name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line621">line 621</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> label value if label exists, null otherwise </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<(string|null)></span> </dd> </dl> <h4 class="name" id="getOwnedRelation"><span class="type-signature">(async) </span>getOwnedRelation<span class="signature">(name)</span><span class="type-signature"> → {Promise.<(<a href="Attribute.html">Attribute</a>|null)>}</span></h4> <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>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">relation name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line609">line 609</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> relation if it exists, null otherwise </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<(<a href="Attribute.html">Attribute</a>|null)></span> </dd> </dl> <h4 class="name" id="getOwnedRelations"><span class="type-signature">(async) </span>getOwnedRelations<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<<a href="Attribute.html">Attribute</a>>>}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">relation name to filter</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line309">line 309</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> all note's relations (attributes with type relation), excluding inherited ones </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Attribute.html">Attribute</a>>></span> </dd> </dl> <h4 class="name" id="getOwnedRelationTarget"><span class="type-signature">(async) </span>getOwnedRelationTarget<span class="signature">(name)</span><span class="type-signature"> → {Promise.<<a href="Note.html">Note</a>>|null}</span></h4> <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>name</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="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line649">line 649</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> target note of the relation or null (if target is empty or note was not found) </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<<a href="Note.html">Note</a>></span> | <span class="param-type">null</span> </dd> </dl> <h4 class="name" id="getOwnedRelationValue"><span class="type-signature">(async) </span>getOwnedRelationValue<span class="signature">(name)</span><span class="type-signature"> → {Promise.<(string|null)>}</span></h4> <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>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">relation name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line633">line 633</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> relation value if relation exists, null otherwise </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<(string|null)></span> </dd> </dl> <h4 class="name" id="getParentNotes"><span class="type-signature">(async) </span>getParentNotes<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="Note.html">Note</a>>>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line854">line 854</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> parent notes of this note (note can have multiple parents because of cloning) </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Note.html">Note</a>>></span> </dd> </dl> <h4 class="name" id="getRelation"><span class="type-signature">(async) </span>getRelation<span class="signature">(name)</span><span class="type-signature"> → {Promise.<(<a href="Attribute.html">Attribute</a>|null)>}</span></h4> <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>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">relation name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line603">line 603</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> relation if it exists, null otherwise </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<(<a href="Attribute.html">Attribute</a>|null)></span> </dd> </dl> <h4 class="name" id="getRelationDefinitions"><span class="type-signature">(async) </span>getRelationDefinitions<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<<a href="Attribute.html">Attribute</a>>>}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">relation name to filter</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line332">line 332</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> all note's relation definitions including inherited ones </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Attribute.html">Attribute</a>>></span> </dd> </dl> <h4 class="name" id="getRelations"><span class="type-signature">(async) </span>getRelations<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<<a href="Attribute.html">Attribute</a>>>}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">relation name to filter</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line301">line 301</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> all note's relations (attributes with type relation), including inherited ones </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Attribute.html">Attribute</a>>></span> </dd> </dl> <h4 class="name" id="getRelationTarget"><span class="type-signature">(async) </span>getRelationTarget<span class="signature">(name)</span><span class="type-signature"> → {Promise.<<a href="Note.html">Note</a>>|null}</span></h4> <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>name</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="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line639">line 639</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> target note of the relation or null (if target is empty or note was not found) </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<<a href="Note.html">Note</a>></span> | <span class="param-type">null</span> </dd> </dl> <h4 class="name" id="getRelationTargets"><span class="type-signature">(async) </span>getRelationTargets<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<<a href="Note.html">Note</a>>>}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">relation name to filter</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line317">line 317</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Note.html">Note</a>>></span> </dd> </dl> <h4 class="name" id="getRelationValue"><span class="type-signature">(async) </span>getRelationValue<span class="signature">(name)</span><span class="type-signature"> → {Promise.<(string|null)>}</span></h4> <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>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">relation name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line627">line 627</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> relation value if relation exists, null otherwise </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<(string|null)></span> </dd> </dl> <h4 class="name" id="getRevisions"><span class="type-signature">(async) </span>getRevisions<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="NoteRevision.html">NoteRevision</a>>>}</span></h4> <div class="description"> Returns note revisions of this note. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line791">line 791</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="NoteRevision.html">NoteRevision</a>>></span> </dd> </dl> <h4 class="name" id="getScriptEnv"><span class="type-signature"></span>getScriptEnv<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line183">line 183</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> JS script environment - either "frontend" or "backend" </div> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> <h4 class="name" id="getTargetRelations"><span class="type-signature">(async) </span>getTargetRelations<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<<a href="Attribute.html">Attribute</a>>>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line245">line 245</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> relations targetting this specific note </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Array.<<a href="Attribute.html">Attribute</a>>></span> </dd> </dl> <h4 class="name" id="hasAttribute"><span class="type-signature">(async) </span>hasAttribute<span class="signature">(type, name)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4> <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>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">attribute type (label, relation, etc.)</td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">attribute name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line418">line 418</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> true if note has an attribute with given type and name (including inherited) </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<boolean></span> </dd> </dl> <h4 class="name" id="hasChildren"><span class="type-signature">(async) </span>hasChildren<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line821">line 821</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> - true if note has children </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id="hasLabel"><span class="type-signature">(async) </span>hasLabel<span class="signature">(name)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4> <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>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">label name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line567">line 567</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> true if label exists (including inherited) </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<boolean></span> </dd> </dl> <h4 class="name" id="hasOwnedAttribute"><span class="type-signature">(async) </span>hasOwnedAttribute<span class="signature">(type, name)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4> <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>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">attribute type (label, relation, etc.)</td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">attribute name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line427">line 427</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> true if note has an attribute with given type and name (excluding inherited) </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<boolean></span> </dd> </dl> <h4 class="name" id="hasOwnedLabel"><span class="type-signature">(async) </span>hasOwnedLabel<span class="signature">(name)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4> <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>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">label name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line573">line 573</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> true if label exists (excluding inherited) </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<boolean></span> </dd> </dl> <h4 class="name" id="hasOwnedRelation"><span class="type-signature">(async) </span>hasOwnedRelation<span class="signature">(name)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4> <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>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">relation name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line585">line 585</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> true if relation exists (excluding inherited) </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<boolean></span> </dd> </dl> <h4 class="name" id="hasRelation"><span class="type-signature">(async) </span>hasRelation<span class="signature">(name)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4> <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>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">relation name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line579">line 579</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> true if relation exists (including inherited) </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<boolean></span> </dd> </dl> <h4 class="name" id="invalidateAttributeCache"><span class="type-signature"></span>invalidateAttributeCache<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Clear note's attributes cache to force fresh reload for next attribute request. Cache is note instance scoped. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line340">line 340</a> </li></ul></dd> </dl> <h4 class="name" id="isDescendantOfNote"><span class="type-signature">(async) </span>isDescendantOfNote<span class="signature">(ancestorNoteId)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4> <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>ancestorNoteId</code></td> <td class="type"> </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_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line889">line 889</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> - true if ancestorNoteId occurs in at least one of the note's paths </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<boolean></span> </dd> </dl> <h4 class="name" id="isHtml"><span class="type-signature"></span>isHtml<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line173">line 173</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> true if this note is HTML </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id="isJavaScript"><span class="type-signature"></span>isJavaScript<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line165">line 165</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> true if this note is JavaScript (code or attachment) </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id="isJson"><span class="type-signature"></span>isJson<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line160">line 160</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> true if this note is of application/json content type </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id="isRoot"><span class="type-signature"></span>isRoot<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line155">line 155</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> true if this note is the root of the note tree. Root note has "root" noteId </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id="isStringNote"><span class="type-signature"></span>isStringNote<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line178">line 178</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> true if the note has string content (not binary) </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id="loadAttributesToCache"><span class="type-signature">(async) </span>loadAttributesToCache<span class="signature">()</span><span class="type-signature"> → {Promise.<void>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line346">line 346</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<void></span> </dd> </dl> <h4 class="name" id="removeAttribute"><span class="type-signature">(async) </span>removeAttribute<span class="signature">(type, name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h4> <div class="description"> Removes given attribute name-value pair if it exists. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">attribute type (label, relation, etc.)</td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">attribute name</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">attribute value (optional)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line524">line 524</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<void></span> </dd> </dl> <h4 class="name" id="removeLabel"><span class="type-signature">(async) </span>removeLabel<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h4> <div class="description"> Remove label name-value pair, if it exists. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">label name</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">label value</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line700">line 700</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<void></span> </dd> </dl> <h4 class="name" id="removeRelation"><span class="type-signature">(async) </span>removeRelation<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h4> <div class="description"> Remove relation name-value pair, if it exists. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">relation name</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">relation value (noteId)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line709">line 709</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<void></span> </dd> </dl> <h4 class="name" id="setAttribute"><span class="type-signature">(async) </span>setAttribute<span class="signature">(type, name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h4> <div class="description"> Update's given attribute's value or creates it if it doesn't exist </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">attribute type (label, relation, etc.)</td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">attribute name</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">attribute value (optional)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line490">line 490</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<void></span> </dd> </dl> <h4 class="name" id="setContent"><span class="type-signature">(async) </span>setContent<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line116">line 116</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id="setJsonContent"><span class="type-signature">(async) </span>setJsonContent<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line150">line 150</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id="setLabel"><span class="type-signature">(async) </span>setLabel<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h4> <div class="description"> Update's given label's value or creates it if it doesn't exist </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">label name</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">label value</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line682">line 682</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<void></span> </dd> </dl> <h4 class="name" id="setRelation"><span class="type-signature">(async) </span>setRelation<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h4> <div class="description"> Update's given relation's value or creates it if it doesn't exist </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">relation name</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">relation value (noteId)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line691">line 691</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<void></span> </dd> </dl> <h4 class="name" id="toggleAttribute"><span class="type-signature">(async) </span>toggleAttribute<span class="signature">(type, enabled, name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h4> <div class="description"> Based on enabled, attribute is either set or removed. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">attribute type ('relation', 'label' etc.)</td> </tr> <tr> <td class="name"><code>enabled</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> </td> <td class="description last">toggle On or Off</td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">attribute name</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">attribute value (optional)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line473">line 473</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<void></span> </dd> </dl> <h4 class="name" id="toggleLabel"><span class="type-signature">(async) </span>toggleLabel<span class="signature">(enabled, name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h4> <div class="description"> Based on enabled, label is either set or removed. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>enabled</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> </td> <td class="description last">toggle On or Off</td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">label name</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">label value (optional)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line663">line 663</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<void></span> </dd> </dl> <h4 class="name" id="toggleRelation"><span class="type-signature">(async) </span>toggleRelation<span class="signature">(enabled, name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<void>}</span></h4> <div class="description"> Based on enabled, relation is either set or removed. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>enabled</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> </td> <td class="description last">toggle On or Off</td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last">relation name</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">relation value (noteId)</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="entities_note.js.html">entities/note.js</a>, <a href="entities_note.js.html#line673">line 673</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<void></span> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ApiToken.html">ApiToken</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="Entity.html">Entity</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>