trilium/docs/frontend_api/NoteShort.html

6726 lines
67 KiB
HTML
Raw Normal View History

2018-08-30 02:44:35 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: NoteShort</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: NoteShort</h1>
<section>
<header>
2020-02-02 18:44:08 +08:00
<h2><span class="attribs"><span class="type-signature"></span></span>NoteShort<span class="signature">(treeCache, row)</span><span class="type-signature"></span></h2>
2018-08-30 02:44:35 +08:00
2019-11-09 05:34:30 +08:00
<div class="class-description">This note's representation is used in note tree and is kept in TreeCache.</div>
2018-08-30 02:44:35 +08:00
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="NoteShort"><span class="type-signature"></span>new NoteShort<span class="signature">(treeCache, row)</span><span class="type-signature"></span></h4>
2018-08-30 02:44:35 +08:00
2019-10-26 16:00:26 +08:00
<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>treeCache</code></td>
<td class="type">
<span class="param-type">TreeCache</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>row</code></td>
<td class="type">
<span class="param-type">Object.&lt;string, Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
2018-08-30 02:44:35 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line17">line 17</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
2018-08-30 02:44:35 +08:00
</div>
<h3 class="subsection-title">Members</h3>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="attributes"><span class="type-signature"></span>attributes<span class="type-signature"> :Array.&lt;string></span></h4>
2018-08-30 02:44:35 +08:00
2020-02-02 18:44:08 +08:00
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.&lt;string></span>
</li>
</ul>
2018-08-30 02:44:35 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line21">line 21</a>
2019-10-26 16:00:26 +08:00
</li></ul></dd>
</dl>
<h4 class="name" id="children"><span class="type-signature"></span>children<span class="type-signature"> :Array.&lt;string></span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.&lt;string></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line29">line 29</a>
2019-10-26 16:00:26 +08:00
</li></ul></dd>
</dl>
<h4 class="name" id="childToBranch"><span class="type-signature"></span>childToBranch<span class="type-signature"> :Object.&lt;string, string></span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object.&lt;string, string></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line35">line 35</a>
2019-11-19 06:01:31 +08:00
</li></ul></dd>
</dl>
<h4 class="name" id="contentLength"><span class="type-signature"></span>contentLength<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line46">line 46</a>
</li></ul></dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="isDeleted"><span class="type-signature"></span>isDeleted<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line54">line 54</a>
</li></ul></dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="isProtected"><span class="type-signature"></span>isProtected<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line48">line 48</a>
</li></ul></dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="mime"><span class="type-signature"></span>mime<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line52">line 52</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="noteId"><span class="type-signature"></span>noteId<span class="type-signature"></span></h4>
2018-08-30 02:44:35 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line42">line 42</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="parents"><span class="type-signature"></span>parents<span class="type-signature"> :Array.&lt;string></span></h4>
2018-08-30 02:44:35 +08:00
2020-02-02 18:44:08 +08:00
<h5>Type:</h5>
<ul>
<li>
2018-08-30 02:44:35 +08:00
2020-02-02 18:44:08 +08:00
<span class="param-type">Array.&lt;string></span>
2018-08-30 02:44:35 +08:00
2020-02-02 18:44:08 +08:00
</li>
</ul>
2018-08-30 02:44:35 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line27">line 27</a>
2019-10-26 16:00:26 +08:00
</li></ul></dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="parentToBranch"><span class="type-signature"></span>parentToBranch<span class="type-signature"> :Object.&lt;string, string></span></h4>
2019-10-26 16:00:26 +08:00
<h5>Type:</h5>
<ul>
<li>
2020-02-02 18:44:08 +08:00
<span class="param-type">Object.&lt;string, string></span>
2019-10-26 16:00:26 +08:00
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line32">line 32</a>
2019-10-26 16:00:26 +08:00
</li></ul></dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="targetRelations"><span class="type-signature"></span>targetRelations<span class="type-signature"> :Array.&lt;string></span></h4>
2019-10-26 16:00:26 +08:00
<h5>Type:</h5>
<ul>
<li>
2020-02-02 18:44:08 +08:00
<span class="param-type">Array.&lt;string></span>
2019-10-26 16:00:26 +08:00
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line24">line 24</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
<h4 class="name" id="title"><span class="type-signature"></span>title<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line44">line 44</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line50">line 50</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
2018-12-23 05:28:49 +08:00
<h4 class="name" id="getAttribute"><span class="type-signature">(async) </span>getAttribute<span class="signature">(type, name)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Attribute.html">Attribute</a>>}</span></h4>
<h5>Parameters:</h5>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<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>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<tr>
<td class="name"><code>name</code></td>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<td class="type">
<span class="param-type">string</span>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
</td>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<td class="description last">attribute name</td>
</tr>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
</tbody>
</table>
2018-08-30 02:44:35 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line290">line 290</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
2018-08-30 02:44:35 +08:00
<h5>Returns:</h5>
2018-12-23 05:28:49 +08:00
<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>
2018-08-30 02:44:35 +08:00
<dl>
<dt>
Type
</dt>
<dd>
2018-12-23 05:28:49 +08:00
<span class="param-type">Promise.&lt;<a href="Attribute.html">Attribute</a>></span>
2018-08-30 02:44:35 +08:00
</dd>
</dl>
2019-12-04 05:53:17 +08:00
<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"> &rarr; {Promise.&lt;Array.&lt;<a href="Attribute.html">Attribute</a>>>}</span></h4>
2018-12-23 05:28:49 +08:00
<h5>Parameters:</h5>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
2018-08-30 02:44:35 +08:00
2019-12-04 05:53:17 +08:00
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">(optional) attribute type to filter</td>
</tr>
2018-12-23 05:28:49 +08:00
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
</td>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<td class="attributes">
&lt;optional><br>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
</td>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2019-12-04 05:53:17 +08:00
<td class="description last">(optional) attribute name to filter</td>
2018-12-23 05:28:49 +08:00
</tr>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
</tbody>
</table>
2018-08-30 02:44:35 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line164">line 164</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
2018-08-30 02:44:35 +08:00
<h5>Returns:</h5>
2019-12-04 05:53:17 +08:00
<div class="param-desc">
all note's attributes, including inherited ones
</div>
2018-08-30 02:44:35 +08:00
<dl>
<dt>
Type
</dt>
<dd>
2018-12-23 05:28:49 +08:00
<span class="param-type">Promise.&lt;Array.&lt;<a href="Attribute.html">Attribute</a>>></span>
2018-08-30 02:44:35 +08:00
</dd>
</dl>
2018-12-23 05:28:49 +08:00
<h4 class="name" id="getAttributeValue"><span class="type-signature">(async) </span>getAttributeValue<span class="signature">(type, name)</span><span class="type-signature"> &rarr; {Promise.&lt;string>}</span></h4>
<h5>Parameters:</h5>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<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>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<tr>
<td class="name"><code>name</code></td>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<td class="type">
<span class="param-type">string</span>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
</td>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<td class="description last">attribute name</td>
</tr>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
</tbody>
</table>
2018-08-30 02:44:35 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line312">line 312</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
2018-08-30 02:44:35 +08:00
<h5>Returns:</h5>
2018-12-23 05:28:49 +08:00
<div class="param-desc">
attribute value of given type and name or null if no such attribute exists.
</div>
2018-08-30 02:44:35 +08:00
<dl>
<dt>
Type
</dt>
<dd>
2018-12-23 05:28:49 +08:00
<span class="param-type">Promise.&lt;string></span>
2018-08-30 02:44:35 +08:00
</dd>
</dl>
2018-12-23 05:28:49 +08:00
<h4 class="name" id="getBranches"><span class="type-signature">(async) </span>getBranches<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="Branch.html">Branch</a>>>}</span></h4>
2018-08-30 02:44:35 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line107">line 107</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
2018-08-30 02:44:35 +08:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
2018-12-23 05:28:49 +08:00
<span class="param-type">Promise.&lt;Array.&lt;<a href="Branch.html">Branch</a>>></span>
2018-08-30 02:44:35 +08:00
</dd>
</dl>
2018-12-23 05:28:49 +08:00
<h4 class="name" id="getChildBranches"><span class="type-signature">(async) </span>getChildBranches<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="Branch.html">Branch</a>>>}</span></h4>
2018-08-30 02:44:35 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line119">line 119</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
2018-08-30 02:44:35 +08:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
2018-12-23 05:28:49 +08:00
<span class="param-type">Promise.&lt;Array.&lt;<a href="Branch.html">Branch</a>>></span>
2018-08-30 02:44:35 +08:00
</dd>
</dl>
2018-12-23 05:28:49 +08:00
<h4 class="name" id="getChildNoteIds"><span class="type-signature"></span>getChildNoteIds<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
2018-08-30 02:44:35 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line137">line 137</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
2018-08-30 02:44:35 +08:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
2018-12-23 05:28:49 +08:00
<span class="param-type">Array.&lt;string></span>
2018-08-30 02:44:35 +08:00
</dd>
</dl>
2018-12-23 05:28:49 +08:00
<h4 class="name" id="getChildNotes"><span class="type-signature">(async) </span>getChildNotes<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>>}</span></h4>
2018-08-30 02:44:35 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line142">line 142</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
2018-08-30 02:44:35 +08:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
2018-12-23 05:28:49 +08:00
<span class="param-type">Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>></span>
2018-08-30 02:44:35 +08:00
</dd>
</dl>
2018-12-23 05:28:49 +08:00
<h4 class="name" id="getLabel"><span class="type-signature">(async) </span>getLabel<span class="signature">(name)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Attribute.html">Attribute</a>>}</span></h4>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<h5>Parameters:</h5>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<tr>
<td class="name"><code>name</code></td>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<td class="type">
<span class="param-type">string</span>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
</td>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
<td class="description last">label name</td>
</tr>
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
</tbody>
</table>
2018-08-30 02:44:35 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line352">line 352</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<h5>Returns:</h5>
<div class="param-desc">
label if it exists, null otherwise
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;<a href="Attribute.html">Attribute</a>></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"> &rarr; {Promise.&lt;Array.&lt;<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">
&lt;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>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line228">line 228</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<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.&lt;Array.&lt;<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"> &rarr; {Promise.&lt;Array.&lt;<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">
&lt;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>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line220">line 220</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<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.&lt;Array.&lt;<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"> &rarr; {Promise.&lt;string>}</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>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line376">line 376</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<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.&lt;string></span>
</dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="getOwnedAttribute"><span class="type-signature"></span>getOwnedAttribute<span class="signature">(type, name)</span><span class="type-signature"> &rarr; {<a href="Attribute.html">Attribute</a>}</span></h4>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<h5>Parameters:</h5>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<table class="params">
<thead>
<tr>
<th>Name</th>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<th>Type</th>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<th class="last">Description</th>
</tr>
</thead>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<tbody>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<tr>
<td class="name"><code>type</code></td>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<td class="type">
<span class="param-type">string</span>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
</td>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<td class="description last">attribute type (label, relation, etc.)</td>
</tr>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<tr>
<td class="name"><code>name</code></td>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<td class="type">
<span class="param-type">string</span>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
</td>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<td class="description last">attribute name</td>
</tr>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
</tbody>
</table>
2018-12-23 05:28:49 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line279">line 279</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<h5>Returns:</h5>
2020-02-02 18:44:08 +08:00
<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>
2018-12-23 05:28:49 +08:00
<dl>
<dt>
Type
</dt>
<dd>
2020-02-02 18:44:08 +08:00
<span class="param-type"><a href="Attribute.html">Attribute</a></span>
2018-12-23 05:28:49 +08:00
</dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="getOwnedAttributes"><span class="type-signature"></span>getOwnedAttributes<span class="signature">(type<span class="signature-attributes">opt</span>, name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Attribute.html">Attribute</a>>}</span></h4>
2018-12-23 05:28:49 +08:00
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
2020-02-02 18:44:08 +08:00
<th>Attributes</th>
2018-12-23 05:28:49 +08:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2020-02-02 18:44:08 +08:00
<td class="name"><code>type</code></td>
2018-12-23 05:28:49 +08:00
<td class="type">
<span class="param-type">string</span>
</td>
2020-02-02 18:44:08 +08:00
<td class="attributes">
&lt;optional><br>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
</td>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<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">
&lt;optional><br>
</td>
<td class="description last">(optional) attribute name to filter</td>
</tr>
2018-12-23 05:28:49 +08:00
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line151">line 151</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<h5>Returns:</h5>
<div class="param-desc">
2020-02-02 18:44:08 +08:00
all note's attributes, including inherited ones
2018-12-23 05:28:49 +08:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
2020-02-02 18:44:08 +08:00
<span class="param-type">Array.&lt;<a href="Attribute.html">Attribute</a>></span>
2018-12-23 05:28:49 +08:00
</dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="getOwnedAttributeValue"><span class="type-signature"></span>getOwnedAttributeValue<span class="signature">(type, name)</span><span class="type-signature"> &rarr; {string}</span></h4>
2018-12-23 05:28:49 +08:00
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2020-02-02 18:44:08 +08:00
<td class="name"><code>type</code></td>
2018-12-23 05:28:49 +08:00
<td class="type">
<span class="param-type">string</span>
</td>
2020-02-02 18:44:08 +08:00
<td class="description last">attribute type (label, relation, etc.)</td>
</tr>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<tr>
<td class="name"><code>name</code></td>
<td class="type">
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<span class="param-type">string</span>
</td>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<td class="description last">attribute name</td>
2018-12-23 05:28:49 +08:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line301">line 301</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<h5>Returns:</h5>
<div class="param-desc">
2020-02-02 18:44:08 +08:00
attribute value of given type and name or null if no such attribute exists.
2018-12-23 05:28:49 +08:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
2020-02-02 18:44:08 +08:00
<span class="param-type">string</span>
2018-12-23 05:28:49 +08:00
</dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="getOwnedLabel"><span class="type-signature"></span>getOwnedLabel<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Attribute.html">Attribute</a>}</span></h4>
2018-12-23 05:28:49 +08:00
<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>
2020-02-02 18:44:08 +08:00
<td class="description last">label name</td>
2018-12-23 05:28:49 +08:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line346">line 346</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<h5>Returns:</h5>
<div class="param-desc">
2020-02-02 18:44:08 +08:00
label if it exists, null otherwise
2018-12-23 05:28:49 +08:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
2020-02-02 18:44:08 +08:00
<span class="param-type"><a href="Attribute.html">Attribute</a></span>
2018-12-23 05:28:49 +08:00
</dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="getOwnedLabels"><span class="type-signature"></span>getOwnedLabels<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Attribute.html">Attribute</a>>}</span></h4>
2018-12-23 05:28:49 +08:00
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
2020-02-02 18:44:08 +08:00
<th>Attributes</th>
2018-12-23 05:28:49 +08:00
<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>
2020-02-02 18:44:08 +08:00
<td class="attributes">
&lt;optional><br>
</td>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<td class="description last">label name to filter</td>
2018-12-23 05:28:49 +08:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line212">line 212</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<h5>Returns:</h5>
<div class="param-desc">
2020-02-02 18:44:08 +08:00
all note's labels (attributes with type label), including inherited ones
2018-12-23 05:28:49 +08:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
2020-02-02 18:44:08 +08:00
<span class="param-type">Array.&lt;<a href="Attribute.html">Attribute</a>></span>
2018-12-23 05:28:49 +08:00
</dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="getOwnedLabelValue"><span class="type-signature"></span>getOwnedLabelValue<span class="signature">(name)</span><span class="type-signature"> &rarr; {string}</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>
2020-02-02 18:44:08 +08:00
<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>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line370">line 370</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
2020-02-02 18:44:08 +08:00
<div class="param-desc">
label value if label exists, null otherwise
</div>
<dl>
<dt>
Type
</dt>
<dd>
2020-02-02 18:44:08 +08:00
<span class="param-type">string</span>
</dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="getOwnedRelation"><span class="type-signature"></span>getOwnedRelation<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Attribute.html">Attribute</a>}</span></h4>
2018-12-23 05:28:49 +08:00
<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>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line358">line 358</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<h5>Returns:</h5>
<div class="param-desc">
2020-02-02 18:44:08 +08:00
relation if it exists, null otherwise
2018-12-23 05:28:49 +08:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
2020-02-02 18:44:08 +08:00
<span class="param-type"><a href="Attribute.html">Attribute</a></span>
2018-12-23 05:28:49 +08:00
</dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="getOwnedRelations"><span class="type-signature"></span>getOwnedRelations<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Attribute.html">Attribute</a>>}</span></h4>
2020-02-02 18:44:08 +08:00
<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">
&lt;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>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line236">line 236</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
2020-02-02 18:44:08 +08:00
<div class="param-desc">
all note's relations (attributes with type relation), including inherited ones
</div>
<dl>
<dt>
Type
</dt>
<dd>
2020-02-02 18:44:08 +08:00
<span class="param-type">Array.&lt;<a href="Attribute.html">Attribute</a>></span>
</dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="getOwnedRelationValue"><span class="type-signature"></span>getOwnedRelationValue<span class="signature">(name)</span><span class="type-signature"> &rarr; {string}</span></h4>
2018-12-23 05:28:49 +08:00
<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>
2020-02-02 18:44:08 +08:00
<td class="description last">relation name</td>
2018-12-23 05:28:49 +08:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line382">line 382</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<h5>Returns:</h5>
<div class="param-desc">
2020-02-02 18:44:08 +08:00
relation value if relation exists, null otherwise
2018-12-23 05:28:49 +08:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
2020-02-02 18:44:08 +08:00
<span class="param-type">string</span>
2018-12-23 05:28:49 +08:00
</dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="getParentNoteIds"><span class="type-signature"></span>getParentNoteIds<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
2018-12-23 05:28:49 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line127">line 127</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
2020-02-02 18:44:08 +08:00
<span class="param-type">Array.&lt;string></span>
2018-12-23 05:28:49 +08:00
</dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="getParentNotes"><span class="type-signature">(async) </span>getParentNotes<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>>}</span></h4>
2018-12-23 05:28:49 +08:00
2020-02-02 18:44:08 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line132">line 132</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</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"> &rarr; {Promise.&lt;<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>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_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line364">line 364</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.&lt;<a href="Attribute.html">Attribute</a>></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"> &rarr; {Promise.&lt;Array.&lt;<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">
&lt;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_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line252">line 252</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.&lt;Array.&lt;<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"> &rarr; {Promise.&lt;Array.&lt;<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">
&lt;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_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line244">line 244</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.&lt;Array.&lt;<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"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</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_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line394">line 394</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.&lt;<a href="NoteShort.html">NoteShort</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"> &rarr; {Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</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">
&lt;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_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line404">line 404</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</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"> &rarr; {Promise.&lt;string>}</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_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line388">line 388</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.&lt;string></span>
</dd>
</dl>
<h4 class="name" id="getTargetRelations"><span class="type-signature"></span>getTargetRelations<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Attribute.html">Attribute</a>>}</span></h4>
<div class="description">
Get relations which target this note
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line428">line 428</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<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"> &rarr; {Promise.&lt;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_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line261">line 261</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.&lt;boolean></span>
</dd>
</dl>
<h4 class="name" id="hasChildren"><span class="type-signature"></span>hasChildren<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line114">line 114</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<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"> &rarr; {Promise.&lt;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_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line328">line 328</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.&lt;boolean></span>
</dd>
</dl>
<h4 class="name" id="hasOwnedAttribute"><span class="type-signature"></span>hasOwnedAttribute<span class="signature">(type, name)</span><span class="type-signature"> &rarr; {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_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line270">line 270</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">boolean</span>
</dd>
</dl>
<h4 class="name" id="hasOwnedLabel"><span class="type-signature"></span>hasOwnedLabel<span class="signature">(name)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
2018-12-23 05:28:49 +08:00
<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>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line322">line 322</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<h5>Returns:</h5>
<div class="param-desc">
2020-02-02 18:44:08 +08:00
true if label exists (excluding inherited)
2018-12-23 05:28:49 +08:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
2020-02-02 18:44:08 +08:00
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="hasOwnedRelation"><span class="type-signature"></span>hasOwnedRelation<span class="signature">(name)</span><span class="type-signature"> &rarr; {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_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line334">line 334</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">boolean</span>
2018-12-23 05:28:49 +08:00
</dd>
</dl>
<h4 class="name" id="hasRelation"><span class="type-signature">(async) </span>hasRelation<span class="signature">(name)</span><span class="type-signature"> &rarr; {Promise.&lt;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>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line340">line 340</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<h5>Returns:</h5>
<div class="param-desc">
true if relation exists (including inherited)
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;boolean></span>
</dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="invalidateAttributeCache"><span class="type-signature"></span>invalidateAttributeCache<span class="signature">()</span><span class="type-signature"></span></h4>
2018-12-23 05:28:49 +08:00
<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>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line419">line 419</a>
2018-12-23 05:28:49 +08:00
</li></ul></dd>
</dl>
2018-12-23 05:28:49 +08:00
<h4 class="name" id="isJson"><span class="type-signature"></span>isJson<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2020-02-02 18:44:08 +08:00
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line82">line 82</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
2018-08-30 02:44:35 +08:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
2020-02-02 18:44:08 +08:00
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3><a href="global.html">Global</a></h3>
2018-08-30 02:44:35 +08:00
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a>
2018-08-30 02:44:35 +08:00
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>