Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-31 18:36:30 +01:00
Code Issues Packages Projects Releases Activity
Files
d09d3f5a9667268d9fa2fa0cfab7b734e5fd242b
Trilium/docs/backend_api/BNote.html

14890 lines
154 KiB
HTML
Raw Normal View History

added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
docs updated
2023-01-03 13:54:27 +01:00
<title>JSDoc: Class: BNote</title>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<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">
docs updated
2023-01-03 13:54:27 +01:00
<h1 class="page-title">Class: BNote</h1>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<section>
<header>
docs updated
2023-01-03 13:54:27 +01:00
<h2><span class="attribs"><span class="type-signature"></span></span>BNote<span class="signature">()</span><span class="type-signature"></span></h2>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs
2023-07-15 12:07:45 +02:00
<div class="class-description">Trilium's main entity, which can represent text note, image, code note, file attachment etc.</div>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
docs updated
2023-01-03 13:54:27 +01:00
<h4 class="name" id="BNote"><span class="type-signature"></span>new BNote<span class="signature">()</span><span class="type-signature"></span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line25">line 25</a>
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
</div>
fix docs
2022-04-16 00:17:32 +02:00
<h3 class="subsection-title">Extends</h3>
<ul>
docs updated
2023-01-03 13:54:27 +01:00
<li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
fix docs
2022-04-16 00:17:32 +02:00
</ul>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<h3 class="subsection-title">Members</h3>
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="__flatTextCache"><span class="type-signature"></span>__flatTextCache<span class="type-signature"> :string|null</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
|
<span class="param-type">null</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line90">line 90</a>
</li></ul></dd>
</dl>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<h4 class="name" id="becca"><span class="type-signature">(protected) </span>becca<span class="type-signature"></span></h4>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<dl class="details">
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
docs updated
2023-01-03 13:54:27 +01:00
<a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</li></ul></dd>
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line55">line 55</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="blobId"><span class="type-signature"></span>blobId<span class="type-signature"> :string</span></h4>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line70">line 70</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="dateCreated"><span class="type-signature"></span>dateCreated<span class="type-signature"> :string</span></h4>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line72">line 72</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="dateModified"><span class="type-signature"></span>dateModified<span class="type-signature"> :string</span></h4>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line74">line 74</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
docs update
2022-12-14 23:51:56 +01:00
</dl>
<h4 class="name" id="isBeingDeleted"><span class="type-signature"></span>isBeingDeleted<span class="type-signature"> :boolean</span></h4>
<div class="description">
- set during the deletion operation, before it is completed (removed from becca completely)
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line80">line 80</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
<h4 class="name" id="isDecrypted"><span class="type-signature"></span>isDecrypted<span class="type-signature"> :boolean</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line85">line 85</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
<h4 class="name" id="isProtected"><span class="type-signature"></span>isProtected<span class="type-signature"> :boolean</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line68">line 68</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
<h4 class="name" id="mime"><span class="type-signature"></span>mime<span class="type-signature"> :string</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line66">line 66</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
<h4 class="name" id="noteId"><span class="type-signature"></span>noteId<span class="type-signature"> :string</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line60">line 60</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<h4 class="name" id="title"><span class="type-signature"></span>title<span class="type-signature"> :string</span></h4>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line62">line 62</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<h5>Type:</h5>
<ul>
<li>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<span class="param-type">string</span>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</li>
</ul>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line64">line 64</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<h4 class="name" id="utcDateCreated"><span class="type-signature"></span>utcDateCreated<span class="type-signature"> :string</span></h4>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<h5>Type:</h5>
<ul>
<li>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<span class="param-type">string</span>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</li>
</ul>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line76">line 76</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<h4 class="name" id="utcDateModified"><span class="type-signature"></span>utcDateModified<span class="type-signature"> :string</span></h4>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<h5>Type:</h5>
<ul>
<li>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<span class="param-type">string</span>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</li>
</ul>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line78">line 78</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<h3 class="subsection-title">Methods</h3>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="_getContent"><span class="type-signature">(protected) </span>_getContent<span class="signature">()</span><span class="type-signature"> &rarr; {string|Buffer}</span></h4>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
<dl class="details">
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractBeccaEntity.html#_getContent">AbstractBeccaEntity#_getContent</a>
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
API docs
2023-06-29 20:54:58 +02:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
API docs
2023-06-29 20:54:58 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-08-10 13:40:26 +02:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line246">line 246</a>
API docs
2023-06-29 20:54:58 +02:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
API docs
2023-06-29 20:54:58 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
</dl>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
API docs
2023-06-29 20:54:58 +02:00
<h5>Returns:</h5>
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
API docs
2023-06-29 20:54:58 +02:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
backend api for ZIP export
2022-12-29 21:15:34 +01:00
API docs
2023-06-29 20:54:58 +02:00
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
|
backend api for ZIP export
2022-12-29 21:15:34 +01:00
API docs
2023-06-29 20:54:58 +02:00
<span class="param-type">Buffer</span>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
API docs
2023-06-29 20:54:58 +02:00
</dd>
</dl>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
API docs
2023-06-29 20:54:58 +02:00
backend api for ZIP export
2022-12-29 21:15:34 +01:00
API docs
2023-06-29 20:54:58 +02:00
backend api for ZIP export
2022-12-29 21:15:34 +01:00
API docs
2023-06-29 20:54:58 +02:00
backend api for ZIP export
2022-12-29 21:15:34 +01:00
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="_setContent"><span class="type-signature">(protected) </span>_setContent<span class="signature">()</span><span class="type-signature"></span></h4>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
API docs
2023-06-29 20:54:58 +02:00
backend api for ZIP export
2022-12-29 21:15:34 +01:00
API docs
2023-06-29 20:54:58 +02:00
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractBeccaEntity.html#_setContent">AbstractBeccaEntity#_setContent</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line124">line 124</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addAttribute"><span class="type-signature"></span>addAttribute<span class="signature">(type, name, value<span class="signature-attributes">opt</span>, isInheritable<span class="signature-attributes">opt</span>, position<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="BAttribute.html">BAttribute</a>}</span></h4>
<div class="description">
Adds a new attribute to this note. The attribute is saved and returned.
See addLabel, addRelation for more specific methods.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</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="default">
</td>
<td class="description last">attribute type (label / relation)</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="default">
</td>
<td class="description last">name of the attribute, not including the leading ~/#</td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">value of the attribute - text for labels, target note ID for relations; optional.</td>
</tr>
<tr>
<td class="name"><code>isInheritable</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type">int</span>
|
<span class="param-type">null</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
null
</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>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1327">line 1327</a>
API docs
2023-06-29 20:54:58 +02:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="BAttribute.html">BAttribute</a></span>
</dd>
</dl>
<h4 class="name" id="addLabel"><span class="type-signature"></span>addLabel<span class="signature">(name, value<span class="signature-attributes">opt</span>, isInheritable<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="BAttribute.html">BAttribute</a>}</span></h4>
<div class="description">
Adds a new label to this note. The label attribute is saved and returned.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</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="default">
</td>
<td class="description last">name of the label, not including the leading #</td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">text value of the label; optional</td>
</tr>
<tr>
<td class="name"><code>isInheritable</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</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>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1348">line 1348</a>
API docs
2023-06-29 20:54:58 +02:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="BAttribute.html">BAttribute</a></span>
</dd>
</dl>
<h4 class="name" id="addRelation"><span class="type-signature"></span>addRelation<span class="signature">(name, targetNoteId, isInheritable<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="BAttribute.html">BAttribute</a>}</span></h4>
<div class="description">
Adds a new relation to this note. The relation attribute is saved and
returned.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</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="default">
</td>
<td class="description last">name of the relation, not including the leading ~</td>
</tr>
<tr>
<td class="name"><code>targetNoteId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>isInheritable</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
<td class="attributes">
&lt;optional><br>
API docs
2023-06-29 20:54:58 +02:00
</td>
<td class="default">
false
</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>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1361">line 1361</a>
API docs
2023-06-29 20:54:58 +02:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="BAttribute.html">BAttribute</a></span>
</dd>
</dl>
<h4 class="name" id="beforeSaving"><span class="type-signature">(protected) </span>beforeSaving<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
<h4 class="name" id="cloneTo"><span class="type-signature"></span>cloneTo<span class="signature">(parentNoteId)</span><span class="type-signature"> &rarr; {Object}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
API docs
2023-06-29 20:54:58 +02:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parentNoteId</code></td>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
API docs
2023-06-29 20:54:58 +02:00
<td class="type">
backend api for ZIP export
2022-12-29 21:15:34 +01:00
API docs
2023-06-29 20:54:58 +02:00
</td>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
<td class="description last"></td>
</tr>
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
</tbody>
</table>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1446">line 1446</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<h5>Returns:</h5>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<dl>
<dt>
Type
</dt>
<dd>
API docs
2023-06-29 20:54:58 +02:00
<span class="param-type">Object</span>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
</dd>
</dl>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="convertToParentAttachment"><span class="type-signature"></span>convertToParentAttachment<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BAttachment.html">BAttachment</a>|null}</span></h4>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
<div class="description">
Some notes are eligible for conversion into an attachment of its parent, note must have these properties:
- it has exactly one target relation
- it has a relation from its parent note
- it has no children
- it has no clones
API docs
2023-07-15 12:07:45 +02:00
- the parent is of type text
API docs
2023-06-29 20:54:58 +02:00
- both notes are either unprotected or user is in protected session
Currently, works only for image notes.
API docs
2023-07-15 12:07:45 +02:00
In the future, this functionality might get more generic and some of the requirements relaxed.
API docs
2023-06-29 20:54:58 +02:00
</div>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<dl class="details">
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1498">line 1498</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
API docs
2023-06-29 20:54:58 +02:00
<h5>Returns:</h5>
<div class="param-desc">
- null if note is not eligible for conversion
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="BAttachment.html">BAttachment</a></span>
|
<span class="param-type">null</span>
</dd>
</dl>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="deleteNote"><span class="type-signature"></span>deleteNote<span class="signature">(deleteId<span class="signature-attributes">opt</span>, taskContext<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
<div class="description">
API docs
2023-06-29 20:54:58 +02:00
(Soft) delete a note and all its descendants.
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
</div>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
<h5>Parameters:</h5>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
<table class="params">
<thead>
<tr>
<th>Name</th>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
<th>Type</th>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
<th>Attributes</th>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
backend api for ZIP export
2022-12-29 21:15:34 +01:00
<th>Default</th>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
<th class="last">Description</th>
</tr>
</thead>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
<tbody>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
<tr>
API docs
2023-06-29 20:54:58 +02:00
<td class="name"><code>deleteId</code></td>
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
<td class="type">
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
<span class="param-type">string</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
<td class="attributes">
&lt;optional><br>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
</td>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
backend api for ZIP export
2022-12-29 21:15:34 +01:00
<td class="default">
API docs
2023-06-29 20:54:58 +02:00
null
backend api for ZIP export
2022-12-29 21:15:34 +01:00
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs
2023-06-29 20:54:58 +02:00
<td class="description last">optional delete identified</td>
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
</tr>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
<tr>
API docs
2023-06-29 20:54:58 +02:00
<td class="name"><code>taskContext</code></td>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
<td class="type">
API docs
2023-06-29 20:54:58 +02:00
<span class="param-type">TaskContext</span>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
API docs
2023-06-29 20:54:58 +02:00
null
backend api for ZIP export
2022-12-29 21:15:34 +01:00
</td>
<td class="description last"></td>
</tr>
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
</tbody>
</table>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<dl class="details">
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1536">line 1536</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed switch between autobook and text
2020-02-02 11:44:08 +01:00
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="generateHash"><span class="type-signature">(protected) </span>generateHash<span class="signature">()</span><span class="type-signature"></span></h4>
Merge branch 'master' into trilium-docs-noformat
2022-08-27 13:45:22 -07:00
removed obsolete isoDateXXX API methods
2019-03-14 20:49:10 +01:00
backend api for ZIP export
2022-12-29 21:15:34 +01:00
removed obsolete isoDateXXX API methods
2019-03-14 20:49:10 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl class="details">
API docs
2023-06-29 20:54:58 +02:00
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line32">line 32</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="generateIdIfNecessary"><span class="type-signature">(protected) </span>generateIdIfNecessary<span class="signature">()</span><span class="type-signature"></span></h4>
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
update docs
2022-08-27 13:42:44 -07:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
<dl class="details">
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
</li></ul></dd>
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line25">line 25</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
update docs
2022-08-27 13:42:44 -07:00
</dl>
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="getAllNotePaths"><span class="type-signature"></span>getAllNotePaths<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;Array.&lt;string>>}</span></h4>
update docs
2022-08-27 13:42:44 -07:00
API docs
2023-06-29 20:54:58 +02:00
<div class="description">
Gives all possible note paths leading to this note. Paths containing search note are ignored (could form cycles)
</div>
update docs
2022-08-27 13:42:44 -07:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1168">line 1168</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
update docs
2022-08-27 13:42:44 -07:00
</dl>
<h5>Returns:</h5>
API docs
2023-06-29 20:54:58 +02:00
<div class="param-desc">
- array of notePaths (each represented by array of noteIds constituting the particular note path)
</div>
update docs
2022-08-27 13:42:44 -07:00
<dl>
<dt>
Type
</dt>
<dd>
API docs
2023-06-29 20:54:58 +02:00
<span class="param-type">Array.&lt;Array.&lt;string>></span>
update docs
2022-08-27 13:42:44 -07:00
</dd>
</dl>
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="getAncestorNoteIds"><span class="type-signature"></span>getAncestorNoteIds<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
update docs
2022-08-27 13:42:44 -07:00
removed obsolete isoDateXXX API methods
2019-03-14 20:49:10 +01:00
update docs
2022-08-27 13:42:44 -07:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1044">line 1044</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
</dl>
API docs
2023-06-29 20:54:58 +02:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;string></span>
</dd>
</dl>
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="getAncestors"><span class="type-signature"></span>getAncestors<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BNote.html">BNote</a>>}</span></h4>
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
<dl class="details">
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1018">line 1018</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
</dl>
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
API docs
2023-06-29 20:54:58 +02:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BNote.html">BNote</a>></span>
</dd>
</dl>
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="getAttachmentById"><span class="type-signature"></span>getAttachmentById<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BAttachment.html">BAttachment</a>|null}</span></h4>
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1125">line 1125</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
</dl>
API docs
2023-06-29 20:54:58 +02:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="BAttachment.html">BAttachment</a></span>
|
<span class="param-type">null</span>
</dd>
</dl>
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
configurable keyboard shortcuts WIP
2019-11-18 23:01:31 +01:00
API docs
2023-09-23 00:04:32 +02:00
<h4 class="name" id="getAttachmentByTitle"><span class="type-signature"></span>getAttachmentByTitle<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BAttachment.html">BAttachment</a>}</span></h4>
updated note menu with current shortcuts
2019-11-23 22:56:35 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1152">line 1152</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
updated note menu with current shortcuts
2019-11-23 22:56:35 +01:00
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
API docs
2023-09-23 00:04:32 +02:00
<span class="param-type"><a href="BAttachment.html">BAttachment</a></span>
updated note menu with current shortcuts
2019-11-23 22:56:35 +01:00
</dd>
</dl>
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="getAttachments"><span class="type-signature"></span>getAttachments<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BAttachment.html">BAttachment</a>>}</span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1107">line 1107</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BAttachment.html">BAttachment</a>></span>
</dd>
</dl>
<h4 class="name" id="getAttachmentsByRole"><span class="type-signature"></span>getAttachmentsByRole<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BAttachment.html">BAttachment</a>>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1140">line 1140</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
API docs
2023-06-29 20:54:58 +02:00
<span class="param-type">Array.&lt;<a href="BAttachment.html">BAttachment</a>></span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
update docs
2023-02-17 16:15:58 +01:00
<h4 class="name" id="getAttribute"><span class="type-signature"></span>getAttribute<span class="signature">(type, name)</span><span class="type-signature"> &rarr; {<a href="BAttribute.html">BAttribute</a>}</span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
API docs updates
2019-12-03 22:53:17 +01:00
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<td class="description last">attribute type (label, relation, etc.)</td>
API docs updates
2019-12-03 22:53:17 +01:00
</tr>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<td class="description last">attribute name</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line581">line 581</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
updated API docs
2018-12-22 22:28:49 +01:00
<div class="param-desc">
API docs
2023-07-15 12:07:45 +02:00
attribute of the given type and name. If there are more such attributes, first is returned.
Returns null if there's no such attribute belonging to this note.
updated API docs
2018-12-22 22:28:49 +01:00
</div>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl>
<dt>
Type
</dt>
<dd>
update docs
2023-02-17 16:15:58 +01:00
<span class="param-type"><a href="BAttribute.html">BAttribute</a></span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
library upgrades
2022-11-07 21:26:13 +01:00
<h4 class="name" id="getAttributeValue"><span class="type-signature"></span>getAttributeValue<span class="signature">(type, name)</span><span class="type-signature"> &rarr; {string|null}</span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
updated API docs
2018-12-22 22:28:49 +01:00
<td class="name"><code>type</code></td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<td class="type">
<span class="param-type">string</span>
</td>
library upgrades
2022-11-07 21:26:13 +01:00
<td class="description last">attribute type (label, relation, etc.)</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</tr>
<tr>
updated API docs
2018-12-22 22:28:49 +01:00
<td class="name"><code>name</code></td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<td class="type">
<span class="param-type">string</span>
</td>
library upgrades
2022-11-07 21:26:13 +01:00
<td class="description last">attribute name</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line592">line 592</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
updated API docs
2018-12-22 22:28:49 +01:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
<h5>Returns:</h5>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<div class="param-desc">
library upgrades
2022-11-07 21:26:13 +01:00
attribute value of given type and name or null if no such attribute exists.
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</div>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
<dl>
<dt>
Type
</dt>
<dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
library upgrades
2022-11-07 21:26:13 +01:00
<span class="param-type">string</span>
|
<span class="param-type">null</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
</dd>
</dl>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
update docs
2023-02-17 16:15:58 +01:00
<h4 class="name" id="getAttributes"><span class="type-signature"></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; {Array.&lt;<a href="BAttribute.html">BAttribute</a>>}</span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
small sync fixes and refactorings
2023-07-27 23:22:08 +02:00
<div class="description">
Beware that the method must not create a copy of the array, but actually returns its internal array
(for performance reasons)
</div>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<h5>Parameters:</h5>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<table class="params">
<thead>
<tr>
<th>Name</th>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<th>Type</th>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
library upgrades
2022-11-07 21:26:13 +01:00
<th>Attributes</th>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<th class="last">Description</th>
</tr>
</thead>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<tbody>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<tr>
<td class="name"><code>type</code></td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<td class="type">
<span class="param-type">string</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
library upgrades
2022-11-07 21:26:13 +01:00
<td class="attributes">
&lt;optional><br>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
library upgrades
2022-11-07 21:26:13 +01:00
</td>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
library upgrades
2022-11-07 21:26:13 +01:00
<td class="description last">(optional) attribute type to filter</td>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</tr>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<tr>
<td class="name"><code>name</code></td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<td class="type">
<span class="param-type">string</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
library upgrades
2022-11-07 21:26:13 +01:00
<td class="attributes">
&lt;optional><br>
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
library upgrades
2022-11-07 21:26:13 +01:00
<td class="description last">(optional) attribute name to filter</td>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</tr>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</tbody>
</table>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
<dl class="details">
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line334">line 334</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
updated API docs
2018-12-22 22:28:49 +01:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
<h5>Returns:</h5>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
<div class="param-desc">
library upgrades
2022-11-07 21:26:13 +01:00
all note's attributes, including inherited ones
updated API docs
2018-12-22 22:28:49 +01:00
</div>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
<dl>
<dt>
Type
</dt>
<dd>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
update docs
2023-02-17 16:15:58 +01:00
<span class="param-type">Array.&lt;<a href="BAttribute.html">BAttribute</a>></span>
updated API docs
2020-09-30 22:48:30 +02:00
</dd>
</dl>
script api docs
2023-05-31 14:00:37 +02:00
<h4 class="name" id="getBestNotePath"><span class="type-signature"></span>getBestNotePath<span class="signature">(hoistedNoteId<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
<div class="description">
API docs
2023-07-15 12:07:45 +02:00
Returns a note path considered to be the "best"
script api docs
2023-05-31 14:00:37 +02:00
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hoistedNoteId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'root'
</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>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1221">line 1221</a>
script api docs
2023-05-31 14:00:37 +02:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
array of noteIds constituting the particular note path
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;string></span>
</dd>
</dl>
<h4 class="name" id="getBestNotePathString"><span class="type-signature"></span>getBestNotePathString<span class="signature">(hoistedNoteId<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
API docs
2023-07-15 12:07:45 +02:00
Returns a note path considered to be the "best"
script api docs
2023-05-31 14:00:37 +02:00
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hoistedNoteId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'root'
</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>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1231">line 1231</a>
script api docs
2023-05-31 14:00:37 +02:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
serialized note path (e.g. 'root/a1h315/js725h')
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
jsdoc fixes to make export simpler
2023-01-03 14:31:46 +01:00
<h4 class="name" id="getBranches"><span class="type-signature"></span>getBranches<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BBranch.html">BBranch</a>>}</span></h4>
updated API docs
2020-09-30 22:48:30 +02:00
<dl class="details">
API docs update
2022-01-05 20:31:21 +01:00
<dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>use getParentBranches() instead</li></ul></dd>
updated API docs
2020-09-30 22:48:30 +02:00
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line176">line 176</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
updated API docs
2020-09-30 22:48:30 +02:00
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
jsdoc fixes to make export simpler
2023-01-03 14:31:46 +01:00
<span class="param-type">Array.&lt;<a href="BBranch.html">BBranch</a>></span>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
</dd>
</dl>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
jsdoc fixes to make export simpler
2023-01-03 14:31:46 +01:00
<h4 class="name" id="getChildBranches"><span class="type-signature"></span>getChildBranches<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BBranch.html">BBranch</a>>}</span></h4>
update API docs
2019-02-20 22:24:51 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line196">line 196</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
update API docs
2019-02-20 22:24:51 +01:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
update API docs
2019-02-20 22:24:51 +01:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
jsdoc fixes to make export simpler
2023-01-03 14:31:46 +01:00
<span class="param-type">Array.&lt;<a href="BBranch.html">BBranch</a>></span>
update API docs
2019-02-20 22:24:51 +01:00
</dd>
</dl>
docs updated
2023-01-03 13:54:27 +01:00
<h4 class="name" id="getChildNotes"><span class="type-signature"></span>getChildNotes<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BNote.html">BNote</a>>}</span></h4>
updated API docs
2018-12-22 22:28:49 +01:00
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line186">line 186</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
docs updated
2023-01-03 13:54:27 +01:00
<span class="param-type">Array.&lt;<a href="BNote.html">BNote</a>></span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="getContent"><span class="type-signature"></span>getContent<span class="signature">()</span><span class="type-signature"> &rarr; {string|Buffer}</span></h4>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
updated API docs
2018-12-22 22:28:49 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line210">line 210</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
API docs
2023-06-29 20:54:58 +02:00
<span class="param-type">string</span>
|
<span class="param-type">Buffer</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
API docs
2023-09-23 00:04:32 +02:00
<h4 class="name" id="getDescendantNoteIds"><span class="type-signature"></span>getDescendantNoteIds<span class="signature">()</span><span class="type-signature"></span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
<dl class="details">
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
API docs
2023-09-23 00:04:32 +02:00
<dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>use getSubtreeNoteIds() instead</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line965">line 965</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2018-12-22 22:28:49 +01:00
</dl>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
backend api for ZIP export
2022-12-29 21:15:34 +01:00
API docs
2023-09-23 00:04:32 +02:00
<h4 class="name" id="getFlatText"><span class="type-signature"></span>getFlatText<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
API docs
2023-09-23 00:04:32 +02:00
<div class="description">
This is used for:
- fast searching
- note similarity evaluation
</div>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line766">line 766</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
</dl>
API docs
2023-09-23 00:04:32 +02:00
<h5>Returns:</h5>
<div class="param-desc">
- returns flattened textual representation of note, prefixes and attributes
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
updated API docs
2018-12-22 22:28:49 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs
2023-09-23 00:04:32 +02:00
<h4 class="name" id="getInheritingNotes"><span class="type-signature"></span>getInheritingNotes<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BNote.html">BNote</a>>}</span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1070">line 1070</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<div class="param-desc">
API docs
2023-09-23 00:04:32 +02:00
- returns only notes which are templated, does not include their subtrees
in effect returns notes which are influenced by note's non-inheritable attributes
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</div>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl>
<dt>
Type
</dt>
<dd>
API docs
2023-09-23 00:04:32 +02:00
<span class="param-type">Array.&lt;<a href="BNote.html">BNote</a>></span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
API docs
2023-09-23 00:04:32 +02:00
<h4 class="name" id="getJsonContent"><span class="type-signature"></span>getJsonContent<span class="signature">()</span><span class="type-signature"> &rarr; {*}</span></h4>
update docs
2023-02-17 16:15:58 +01:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line217">line 217</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
</dl>
API docs
2023-09-23 00:04:32 +02:00
<h5>Throws:</h5>
<div class="param-desc">
Error in case of invalid JSON
</div>
update docs
2023-02-17 16:15:58 +01:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
API docs
2023-09-23 00:04:32 +02:00
<span class="param-type">*</span>
update docs
2023-02-17 16:15:58 +01:00
</dd>
</dl>
API docs
2023-09-23 00:04:32 +02:00
<h4 class="name" id="getJsonContentSafely"><span class="type-signature"></span>getJsonContentSafely<span class="signature">()</span><span class="type-signature"> &rarr; {*|null}</span></h4>
update API docs
2019-02-20 22:24:51 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line228">line 228</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
update API docs
2019-02-20 22:24:51 +01:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
update API docs
2019-02-20 22:24:51 +01:00
<h5>Returns:</h5>
API docs
2023-09-23 00:04:32 +02:00
<div class="param-desc">
valid object or null if the content cannot be parsed as JSON
</div>
update API docs
2019-02-20 22:24:51 +01:00
<dl>
<dt>
Type
</dt>
<dd>
updated API docs
2020-09-30 22:48:30 +02:00
<span class="param-type">*</span>
API docs
2023-09-23 00:04:32 +02:00
|
<span class="param-type">null</span>
update API docs
2019-02-20 22:24:51 +01:00
</dd>
</dl>
update docs
2023-02-17 16:15:58 +01:00
<h4 class="name" id="getLabel"><span class="type-signature"></span>getLabel<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="BAttribute.html">BAttribute</a>|null}</span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02: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">label name</td>
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line521">line 521</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<div class="param-desc">
label if it exists, null otherwise
</div>
<dl>
<dt>
Type
</dt>
<dd>
update docs
2023-02-17 16:15:58 +01:00
<span class="param-type"><a href="BAttribute.html">BAttribute</a></span>
updated API docs
2020-09-30 22:48:30 +02:00
|
<span class="param-type">null</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
library upgrades
2022-11-07 21:26:13 +01:00
<h4 class="name" id="getLabelValue"><span class="type-signature"></span>getLabelValue<span class="signature">(name)</span><span class="type-signature"> &rarr; {string|null}</span></h4>
display mirror relations correctly on relation map
2018-11-13 12:50:08 +01: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>
library upgrades
2022-11-07 21:26:13 +01:00
<td class="description last">label name</td>
display mirror relations correctly on relation map
2018-11-13 12:50:08 +01:00
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line545">line 545</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
display mirror relations correctly on relation map
2018-11-13 12:50:08 +01:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
display mirror relations correctly on relation map
2018-11-13 12:50:08 +01:00
<h5>Returns:</h5>
<div class="param-desc">
library upgrades
2022-11-07 21:26:13 +01:00
label value if label exists, null otherwise
display mirror relations correctly on relation map
2018-11-13 12:50:08 +01:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
library upgrades
2022-11-07 21:26:13 +01:00
<span class="param-type">string</span>
|
<span class="param-type">null</span>
display mirror relations correctly on relation map
2018-11-13 12:50:08 +01:00
</dd>
</dl>
library upgrades
2022-11-07 21:26:13 +01:00
<h4 class="name" id="getLabelValues"><span class="type-signature"></span>getLabelValues<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
<h5>Parameters:</h5>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
library upgrades
2022-11-07 21:26:13 +01:00
<th>Attributes</th>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
<tr>
<td class="name"><code>name</code></td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
<td class="type">
<span class="param-type">string</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
library upgrades
2022-11-07 21:26:13 +01:00
<td class="attributes">
&lt;optional><br>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
library upgrades
2022-11-07 21:26:13 +01:00
</td>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
library upgrades
2022-11-07 21:26:13 +01:00
<td class="description last">label name to filter</td>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
</tr>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
</tbody>
</table>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line621">line 621</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<div class="param-desc">
library upgrades
2022-11-07 21:26:13 +01:00
all note's label values, including inherited ones
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
library upgrades
2022-11-07 21:26:13 +01:00
<span class="param-type">Array.&lt;string></span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
update docs
2023-02-17 16:15:58 +01:00
<h4 class="name" id="getLabels"><span class="type-signature"></span>getLabels<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BAttribute.html">BAttribute</a>>}</span></h4>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<h5>Parameters:</h5>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<tr>
<td class="name"><code>name</code></td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<td class="type">
<span class="param-type">string</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<td class="attributes">
&lt;optional><br>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<td class="description last">label name to filter</td>
</tr>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</tbody>
</table>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line613">line 613</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<div class="param-desc">
library upgrades
2022-11-07 21:26:13 +01:00
all note's labels (attributes with type label), including inherited ones
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</div>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl>
<dt>
Type
</dt>
<dd>
update docs
2023-02-17 16:15:58 +01:00
<span class="param-type">Array.&lt;<a href="BAttribute.html">BAttribute</a>></span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
update docs
2023-02-17 16:15:58 +01:00
<h4 class="name" id="getOwnedAttribute"><span class="type-signature"></span>getOwnedAttribute<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BAttribute.html">BAttribute</a>}</span></h4>
note revision widget displays only date and time, no time offset
2019-09-07 22:03:08 +02:00
update docs
2023-02-17 16:15:58 +01:00
<dl class="details">
note revision widget displays only date and time, no time offset
2019-09-07 22:03:08 +02:00
update docs
2023-02-17 16:15:58 +01:00
note revision widget displays only date and time, no time offset
2019-09-07 22:03:08 +02:00
update docs
2023-02-17 16:15:58 +01:00
note revision widget displays only date and time, no time offset
2019-09-07 22:03:08 +02:00
update docs
2023-02-17 16:15:58 +01:00
note revision widget displays only date and time, no time offset
2019-09-07 22:03:08 +02:00
update docs
2023-02-17 16:15:58 +01:00
note revision widget displays only date and time, no time offset
2019-09-07 22:03:08 +02:00
update docs
2023-02-17 16:15:58 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
update docs
2023-02-17 16:15:58 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
update docs
2023-02-17 16:15:58 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
update docs
2023-02-17 16:15:58 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
update docs
2023-02-17 16:15:58 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
update docs
2023-02-17 16:15:58 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line691">line 691</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
update docs
2023-02-17 16:15:58 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
update docs
2023-02-17 16:15:58 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
update docs
2023-02-17 16:15:58 +01:00
</dl>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
update docs
2023-02-17 16:15:58 +01:00
<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"><a href="BAttribute.html">BAttribute</a></span>
</dd>
</dl>
<h4 class="name" id="getOwnedAttributeValue"><span class="type-signature"></span>getOwnedAttributeValue<span class="signature">(type, name)</span><span class="type-signature"> &rarr; {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>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line603">line 603</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<div class="param-desc">
library upgrades
2022-11-07 21:26:13 +01:00
attribute value of given type and name or null if no such attribute exists.
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
library upgrades
2022-11-07 21:26:13 +01:00
<span class="param-type">string</span>
|
<span class="param-type">null</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
update docs
2023-02-17 16:15:58 +01: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>, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BAttribute.html">BAttribute</a>>}</span></h4>
API docs updates
2019-12-03 22:53:17 +01:00
small sync fixes and refactorings
2023-07-27 23:22:08 +02:00
<div class="description">
Beware that the method must not create a copy of the array, but actually returns its internal array
(for performance reasons)
</div>
API docs updates
2019-12-03 22:53:17 +01:00
<h5>Parameters:</h5>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
library upgrades
2022-11-07 21:26:13 +01:00
<th>Attributes</th>
API docs updates
2019-12-03 22:53:17 +01:00
docs update
2022-12-14 23:51:56 +01:00
<th>Default</th>
API docs updates
2019-12-03 22:53:17 +01:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
docs update
2022-12-14 23:51:56 +01:00
|
<span class="param-type">null</span>
API docs updates
2019-12-03 22:53:17 +01:00
</td>
library upgrades
2022-11-07 21:26:13 +01:00
<td class="attributes">
&lt;optional><br>
API docs updates
2019-12-03 22:53:17 +01:00
library upgrades
2022-11-07 21:26:13 +01:00
</td>
API docs updates
2019-12-03 22:53:17 +01:00
library upgrades
2022-11-07 21:26:13 +01:00
docs update
2022-12-14 23:51:56 +01:00
<td class="default">
null
</td>
library upgrades
2022-11-07 21:26:13 +01:00
<td class="description last">(optional) attribute type to filter</td>
API docs updates
2019-12-03 22:53:17 +01:00
</tr>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
<tr>
<td class="name"><code>name</code></td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
<td class="type">
<span class="param-type">string</span>
docs update
2022-12-14 23:51:56 +01:00
|
<span class="param-type">null</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
library upgrades
2022-11-07 21:26:13 +01:00
<td class="attributes">
&lt;optional><br>
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
docs update
2022-12-14 23:51:56 +01:00
<td class="default">
null
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
library upgrades
2022-11-07 21:26:13 +01:00
<td class="description last">(optional) attribute name to filter</td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
docs update
2022-12-14 23:51:56 +01:00
|
<span class="param-type">null</span>
library upgrades
2022-11-07 21:26:13 +01:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
docs update
2022-12-14 23:51:56 +01:00
<td class="default">
null
</td>
library upgrades
2022-11-07 21:26:13 +01:00
<td class="description last">(optional) attribute value to filter</td>
API docs updates
2019-12-03 22:53:17 +01:00
</tr>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
</tbody>
</table>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
update API docs
2019-02-20 22:24:51 +01:00
<dl class="details">
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
update API docs
2019-02-20 22:24:51 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
update API docs
2019-02-20 22:24:51 +01:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
update API docs
2019-02-20 22:24:51 +01:00
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line666">line 666</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
update API docs
2019-02-20 22:24:51 +01:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
update API docs
2019-02-20 22:24:51 +01:00
<h5>Returns:</h5>
<div class="param-desc">
library upgrades
2022-11-07 21:26:13 +01:00
note's "owned" attributes - excluding inherited ones
update API docs
2019-02-20 22:24:51 +01:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
update docs
2023-02-17 16:15:58 +01:00
<span class="param-type">Array.&lt;<a href="BAttribute.html">BAttribute</a>></span>
update API docs
2019-02-20 22:24:51 +01:00
</dd>
</dl>
update docs
2023-02-17 16:15:58 +01:00
<h4 class="name" id="getOwnedLabel"><span class="type-signature"></span>getOwnedLabel<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="BAttribute.html">BAttribute</a>|null}</span></h4>
update API docs
2019-02-20 22:24:51 +01: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">
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<span class="param-type">string</span>
</td>
API docs updates
2019-12-03 22:53:17 +01:00
<td class="description last">label name</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line527">line 527</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<div class="param-desc">
API docs updates
2019-12-03 22:53:17 +01:00
label if it exists, null otherwise
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
update docs
2023-02-17 16:15:58 +01:00
<span class="param-type"><a href="BAttribute.html">BAttribute</a></span>
updated API docs
2020-09-30 22:48:30 +02:00
|
<span class="param-type">null</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
library upgrades
2022-11-07 21:26:13 +01:00
<h4 class="name" id="getOwnedLabelValue"><span class="type-signature"></span>getOwnedLabelValue<span class="signature">(name)</span><span class="type-signature"> &rarr; {string|null}</span></h4>
display mirror relations correctly on relation map
2018-11-13 12:50:08 +01: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>
library upgrades
2022-11-07 21:26:13 +01:00
<td class="description last">label name</td>
display mirror relations correctly on relation map
2018-11-13 12:50:08 +01:00
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line551">line 551</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
display mirror relations correctly on relation map
2018-11-13 12:50:08 +01:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
display mirror relations correctly on relation map
2018-11-13 12:50:08 +01:00
<h5>Returns:</h5>
<div class="param-desc">
library upgrades
2022-11-07 21:26:13 +01:00
label value if label exists, null otherwise
display mirror relations correctly on relation map
2018-11-13 12:50:08 +01:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
library upgrades
2022-11-07 21:26:13 +01:00
<span class="param-type">string</span>
|
<span class="param-type">null</span>
display mirror relations correctly on relation map
2018-11-13 12:50:08 +01:00
</dd>
</dl>
library upgrades
2022-11-07 21:26:13 +01:00
<h4 class="name" id="getOwnedLabelValues"><span class="type-signature"></span>getOwnedLabelValues<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
library upgrades
2022-11-07 21:26:13 +01:00
<th>Attributes</th>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02: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>
library upgrades
2022-11-07 21:26:13 +01:00
<td class="attributes">
&lt;optional><br>
</td>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
library upgrades
2022-11-07 21:26:13 +01:00
<td class="description last">label name to filter</td>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
</tr>
</tbody>
</table>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line637">line 637</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<div class="param-desc">
library upgrades
2022-11-07 21:26:13 +01:00
all note's label values, excluding inherited ones
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
library upgrades
2022-11-07 21:26:13 +01:00
<span class="param-type">Array.&lt;string></span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
update docs
2023-02-17 16:15:58 +01: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="BAttribute.html">BAttribute</a>>}</span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<th>Attributes</th>
added jsdocs generated pages
2018-08-29 20:44:35 +02: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>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<td class="attributes">
&lt;optional><br>
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<td class="description last">label name to filter</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line629">line 629</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<div class="param-desc">
library upgrades
2022-11-07 21:26:13 +01:00
all note's labels (attributes with type label), excluding inherited ones
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
update docs
2023-02-17 16:15:58 +01:00
<span class="param-type">Array.&lt;<a href="BAttribute.html">BAttribute</a>></span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
update docs
2023-02-17 16:15:58 +01:00
<h4 class="name" id="getOwnedRelation"><span class="type-signature"></span>getOwnedRelation<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="BAttribute.html">BAttribute</a>|null}</span></h4>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02: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>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<td class="description last">relation name</td>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line539">line 539</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
</dl>
<h5>Returns:</h5>
API docs updates
2019-12-03 22:53:17 +01:00
<div class="param-desc">
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
relation if it exists, null otherwise
API docs updates
2019-12-03 22:53:17 +01:00
</div>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
<dl>
<dt>
Type
</dt>
<dd>
update docs
2023-02-17 16:15:58 +01:00
<span class="param-type"><a href="BAttribute.html">BAttribute</a></span>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
|
<span class="param-type">null</span>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
</dd>
</dl>
library upgrades
2022-11-07 21:26:13 +01:00
<h4 class="name" id="getOwnedRelationValue"><span class="type-signature"></span>getOwnedRelationValue<span class="signature">(name)</span><span class="type-signature"> &rarr; {string|null}</span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02: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>
library upgrades
2022-11-07 21:26:13 +01:00
<td class="description last">relation name</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line563">line 563</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<div class="param-desc">
library upgrades
2022-11-07 21:26:13 +01:00
relation value if relation exists, null otherwise
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
library upgrades
2022-11-07 21:26:13 +01:00
<span class="param-type">string</span>
|
<span class="param-type">null</span>
API docs updates
2019-12-03 22:53:17 +01:00
</dd>
</dl>
update docs
2023-02-17 16:15:58 +01: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="BAttribute.html">BAttribute</a>>}</span></h4>
API docs updates
2019-12-03 22:53:17 +01:00
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
library upgrades
2022-11-07 21:26:13 +01:00
<th>Attributes</th>
API docs updates
2019-12-03 22:53:17 +01: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>
library upgrades
2022-11-07 21:26:13 +01:00
<td class="attributes">
&lt;optional><br>
</td>
API docs updates
2019-12-03 22:53:17 +01:00
library upgrades
2022-11-07 21:26:13 +01:00
<td class="description last">relation name to filter</td>
API docs updates
2019-12-03 22:53:17 +01:00
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line653">line 653</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
API docs updates
2019-12-03 22:53:17 +01:00
</dl>
<h5>Returns:</h5>
<div class="param-desc">
library upgrades
2022-11-07 21:26:13 +01:00
all note's relations (attributes with type relation), excluding inherited ones
API docs updates
2019-12-03 22:53:17 +01:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
update docs
2023-02-17 16:15:58 +01:00
<span class="param-type">Array.&lt;<a href="BAttribute.html">BAttribute</a>></span>
API docs updates
2019-12-03 22:53:17 +01:00
</dd>
</dl>
jsdoc fixes to make export simpler
2023-01-03 14:31:46 +01:00
<h4 class="name" id="getParentBranches"><span class="type-signature"></span>getParentBranches<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BBranch.html">BBranch</a>>}</span></h4>
API docs updates
2019-12-03 22:53:17 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line159">line 159</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
API docs updates
2019-12-03 22:53:17 +01:00
</dl>
<h5>Returns:</h5>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<dl>
<dt>
Type
</dt>
<dd>
jsdoc fixes to make export simpler
2023-01-03 14:31:46 +01:00
<span class="param-type">Array.&lt;<a href="BBranch.html">BBranch</a>></span>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dd>
</dl>
docs updated
2023-01-03 13:54:27 +01:00
<h4 class="name" id="getParentNotes"><span class="type-signature"></span>getParentNotes<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BNote.html">BNote</a>>}</span></h4>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line181">line 181</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
API docs updates
2019-12-03 22:53:17 +01:00
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
docs updated
2023-01-03 13:54:27 +01:00
<span class="param-type">Array.&lt;<a href="BNote.html">BNote</a>></span>
API docs updates
2019-12-03 22:53:17 +01:00
</dd>
</dl>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<h4 class="name" id="getPojoToSave"><span class="type-signature">(protected) </span>getPojoToSave<span class="signature">()</span><span class="type-signature"></span></h4>
API docs updates
2019-12-03 22:53:17 +01:00
<dl class="details">
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
docs updated
2023-01-03 13:54:27 +01:00
<a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
</li></ul></dd>
API docs updates
2019-12-03 22:53:17 +01:00
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line76">line 76</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
API docs updates
2019-12-03 22:53:17 +01:00
</dl>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
update docs
2023-02-17 16:15:58 +01:00
<h4 class="name" id="getRelation"><span class="type-signature"></span>getRelation<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="BAttribute.html">BAttribute</a>|null}</span></h4>
API docs updates
2019-12-03 22:53:17 +01:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
<h5>Parameters:</h5>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
<td class="description last">relation name</td>
</tr>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
</tbody>
</table>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line533">line 533</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
</dl>
<h5>Returns:</h5>
API docs updates
2019-12-03 22:53:17 +01:00
<div class="param-desc">
relation if it exists, null otherwise
</div>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
<dl>
<dt>
Type
</dt>
<dd>
update docs
2023-02-17 16:15:58 +01:00
<span class="param-type"><a href="BAttribute.html">BAttribute</a></span>
updated API docs
2020-09-30 22:48:30 +02:00
|
<span class="param-type">null</span>
API docs updates
2019-12-03 22:53:17 +01:00
</dd>
</dl>
library upgrades
2022-11-07 21:26:13 +01:00
<h4 class="name" id="getRelationValue"><span class="type-signature"></span>getRelationValue<span class="signature">(name)</span><span class="type-signature"> &rarr; {string|null}</span></h4>
API docs updates
2019-12-03 22:53:17 +01: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>
library upgrades
2022-11-07 21:26:13 +01:00
<td class="description last">relation name</td>
API docs updates
2019-12-03 22:53:17 +01:00
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line557">line 557</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
API docs updates
2019-12-03 22:53:17 +01:00
</dl>
<h5>Returns:</h5>
<div class="param-desc">
library upgrades
2022-11-07 21:26:13 +01:00
relation value if relation exists, null otherwise
API docs updates
2019-12-03 22:53:17 +01:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
library upgrades
2022-11-07 21:26:13 +01:00
<span class="param-type">string</span>
|
<span class="param-type">null</span>
API docs updates
2019-12-03 22:53:17 +01:00
</dd>
</dl>
update docs
2023-02-17 16:15:58 +01:00
<h4 class="name" id="getRelations"><span class="type-signature"></span>getRelations<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BAttribute.html">BAttribute</a>>}</span></h4>
API docs updates
2019-12-03 22:53:17 +01:00
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
library upgrades
2022-11-07 21:26:13 +01:00
<th>Attributes</th>
API docs updates
2019-12-03 22:53:17 +01:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
API docs
2023-06-29 20:54:58 +02:00
<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>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line645">line 645</a>
API docs
2023-06-29 20:54:58 +02:00
</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">Array.&lt;<a href="BAttribute.html">BAttribute</a>></span>
</dd>
</dl>
<h4 class="name" id="getRevisions"><span class="type-signature"></span>getRevisions<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BRevision.html">BRevision</a>>}</span></h4>
API docs updates
2019-12-03 22:53:17 +01:00
library upgrades
2022-11-07 21:26:13 +01:00
script api docs
2023-05-31 14:00:37 +02:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1101">line 1101</a>
script api docs
2023-05-31 14:00:37 +02:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
API docs
2023-06-29 20:54:58 +02:00
<span class="param-type">Array.&lt;<a href="BRevision.html">BRevision</a>></span>
script api docs
2023-05-31 14:00:37 +02:00
</dd>
</dl>
<h4 class="name" id="getScriptEnv"><span class="type-signature"></span>getScriptEnv<span class="signature">()</span><span class="type-signature"> &rarr; {string|null}</span></h4>
library upgrades
2022-11-07 21:26:13 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line310">line 310</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
API docs updates
2019-12-03 22:53:17 +01:00
</dl>
<h5>Returns:</h5>
<div class="param-desc">
script api docs
2023-05-31 14:00:37 +02:00
JS script environment - either "frontend" or "backend"
API docs updates
2019-12-03 22:53:17 +01:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
script api docs
2023-05-31 14:00:37 +02:00
<span class="param-type">string</span>
|
<span class="param-type">null</span>
API docs updates
2019-12-03 22:53:17 +01:00
</dd>
</dl>
script api docs
2023-05-31 14:00:37 +02:00
<h4 class="name" id="getSearchResultNotes"><span class="type-signature"></span>getSearchResultNotes<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BNote.html">BNote</a>>}</span></h4>
API docs updates
2019-12-03 22:53:17 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line876">line 876</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
API docs updates
2019-12-03 22:53:17 +01:00
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
script api docs
2023-05-31 14:00:37 +02:00
<span class="param-type">Array.&lt;<a href="BNote.html">BNote</a>></span>
API docs updates
2019-12-03 22:53:17 +01:00
</dd>
</dl>
script api docs
2023-05-31 14:00:37 +02:00
<h4 class="name" id="getSortedNotePathRecords"><span class="type-signature"></span>getSortedNotePathRecords<span class="signature">(hoistedNoteId<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;{isArchived: boolean, isInHoistedSubTree: boolean, notePath: Array.&lt;string>, isHidden: boolean}>}</span></h4>
<h5>Parameters:</h5>
api docs
2022-11-12 20:40:40 +01:00
script api docs
2023-05-31 14:00:37 +02:00
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
api docs
2022-11-12 20:40:40 +01:00
script api docs
2023-05-31 14:00:37 +02:00
<tr>
<td class="name"><code>hoistedNoteId</code></td>
<td class="type">
<span class="param-type">string</span>
api docs
2022-11-12 20:40:40 +01:00
script api docs
2023-05-31 14:00:37 +02:00
</td>
api docs
2022-11-12 20:40:40 +01:00
script api docs
2023-05-31 14:00:37 +02:00
<td class="attributes">
&lt;optional><br>
api docs
2022-11-12 20:40:40 +01:00
script api docs
2023-05-31 14:00:37 +02:00
api docs
2022-11-12 20:40:40 +01:00
script api docs
2023-05-31 14:00:37 +02:00
</td>
api docs
2022-11-12 20:40:40 +01:00
script api docs
2023-05-31 14:00:37 +02:00
<td class="default">
'root'
</td>
api docs
2022-11-12 20:40:40 +01:00
script api docs
2023-05-31 14:00:37 +02:00
<td class="description last"></td>
</tr>
api docs
2022-11-12 20:40:40 +01:00
script api docs
2023-05-31 14:00:37 +02:00
</tbody>
</table>
api docs
2022-11-12 20:40:40 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1190">line 1190</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
api docs
2022-11-12 20:40:40 +01:00
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
script api docs
2023-05-31 14:00:37 +02:00
<span class="param-type">Array.&lt;{isArchived: boolean, isInHoistedSubTree: boolean, notePath: Array.&lt;string>, isHidden: boolean}></span>
api docs
2022-11-12 20:40:40 +01:00
</dd>
</dl>
jsdoc fixes to make export simpler
2023-01-03 14:31:46 +01:00
<h4 class="name" id="getStrongParentBranches"><span class="type-signature"></span>getStrongParentBranches<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BBranch.html">BBranch</a>>}</span></h4>
docs update
2022-12-14 23:51:56 +01:00
<div class="description">
Returns <i>strong</i> (as opposed to <i>weak</i>) parent branches. See isWeak for details.
</div>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line168">line 168</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
docs update
2022-12-14 23:51:56 +01:00
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
jsdoc fixes to make export simpler
2023-01-03 14:31:46 +01:00
<span class="param-type">Array.&lt;<a href="BBranch.html">BBranch</a>></span>
docs update
2022-12-14 23:51:56 +01:00
</dd>
</dl>
library upgrades
2022-11-07 21:26:13 +01:00
<h4 class="name" id="getSubtree"><span class="type-signature"></span>getSubtree<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
API docs updates
2019-12-03 22:53:17 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line899">line 899</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
API docs updates
2019-12-03 22:53:17 +01:00
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
library upgrades
2022-11-07 21:26:13 +01:00
<span class="param-type">Object</span>
API docs updates
2019-12-03 22:53:17 +01:00
</dd>
</dl>
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="getSubtreeNoteIds"><span class="type-signature"></span>getSubtreeNoteIds<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
API docs updates
2019-12-03 22:53:17 +01:00
updated API docs
2020-09-30 22:48:30 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line958">line 958</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
API docs updates
2019-12-03 22:53:17 +01:00
</dl>
<h5>Returns:</h5>
backend api for ZIP export
2022-12-29 21:15:34 +01:00
<div class="param-desc">
API docs
2023-06-29 20:54:58 +02:00
- includes the subtree root note as well
update docs
2023-02-17 16:15:58 +01:00
</div>
API docs updates
2019-12-03 22:53:17 +01:00
<dl>
<dt>
Type
</dt>
<dd>
API docs
2023-06-29 20:54:58 +02:00
<span class="param-type">Array.&lt;string></span>
API docs updates
2019-12-03 22:53:17 +01:00
</dd>
</dl>
update docs
2023-02-17 16:15:58 +01:00
<h4 class="name" id="getSubtreeNotesIncludingTemplated"><span class="type-signature"></span>getSubtreeNotesIncludingTemplated<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BNote.html">BNote</a>>}</span></h4>
API docs updates
2019-12-03 22:53:17 +01:00
updated API docs
2020-09-30 22:48:30 +02:00
<dl class="details">
API docs updates
2019-12-03 22:53:17 +01:00
updated API docs
2020-09-30 22:48:30 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
updated API docs
2020-09-30 22:48:30 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
updated API docs
2020-09-30 22:48:30 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
updated API docs
2020-09-30 22:48:30 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
updated API docs
2020-09-30 22:48:30 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
updated API docs
2020-09-30 22:48:30 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
updated API docs
2020-09-30 22:48:30 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
updated API docs
2020-09-30 22:48:30 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line844">line 844</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
API docs updates
2019-12-03 22:53:17 +01:00
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
docs updated
2023-01-03 13:54:27 +01:00
<span class="param-type">Array.&lt;<a href="BNote.html">BNote</a>></span>
API docs updates
2019-12-03 22:53:17 +01:00
</dd>
</dl>
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="getTargetRelations"><span class="type-signature"></span>getTargetRelations<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BAttribute.html">BAttribute</a>>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1064">line 1064</a>
API docs
2023-06-29 20:54:58 +02:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BAttribute.html">BAttribute</a>></span>
</dd>
</dl>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<h4 class="name" id="getUtcDateChanged"><span class="type-signature">(protected) </span>getUtcDateChanged<span class="signature">()</span><span class="type-signature"></span></h4>
API docs updates
2019-12-03 22:53:17 +01:00
<dl class="details">
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
docs updated
2023-01-03 13:54:27 +01:00
<a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
</li></ul></dd>
API docs updates
2019-12-03 22:53:17 +01:00
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line47">line 47</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
API docs updates
2019-12-03 22:53:17 +01:00
</dl>
fixed jsdoc script API generation, closes #2313
2021-11-10 21:30:54 +01:00
<h4 class="name" id="hasAncestor"><span class="type-signature"></span>hasAncestor<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
API docs updates
2019-12-03 22:53:17 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1049">line 1049</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
API docs updates
2019-12-03 22:53:17 +01:00
</dl>
<h5>Returns:</h5>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
<dl>
<dt>
Type
</dt>
<dd>
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
<span class="param-type">boolean</span>
API docs updates
2019-12-03 22:53:17 +01:00
</dd>
</dl>
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
<h4 class="name" id="hasAttribute"><span class="type-signature"></span>hasAttribute<span class="signature">(type, name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
docs update
2022-12-14 23:51:56 +01:00
<th>Default</th>
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
API docs updates
2019-12-03 22:53:17 +01:00
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
<tr>
<td class="name"><code>type</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
docs update
2022-12-14 23:51:56 +01:00
<td class="default">
</td>
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
<td class="description last"></td>
</tr>
API docs updates
2019-12-03 22:53:17 +01:00
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
<tr>
<td class="name"><code>name</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
docs update
2022-12-14 23:51:56 +01:00
<td class="default">
</td>
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
<td class="description last"></td>
</tr>
API docs updates
2019-12-03 22:53:17 +01:00
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
<tr>
<td class="name"><code>value</code></td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
<td class="type">
</td>
API docs updates
2019-12-03 22:53:17 +01:00
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
<td class="attributes">
&lt;optional><br>
API docs updates
2019-12-03 22:53:17 +01:00
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
</td>
API docs updates
2019-12-03 22:53:17 +01:00
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
docs update
2022-12-14 23:51:56 +01:00
<td class="default">
null
</td>
API docs updates
2019-12-03 22:53:17 +01:00
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
<td class="description last"></td>
</tr>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
added getTargetNote to froca's attribute, fixes #2981
2022-07-11 23:15:16 +02:00
</tbody>
</table>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line451">line 451</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
updated API docs
2020-09-30 22:48:30 +02:00
<span class="param-type">boolean</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
updated API docs
2020-09-30 22:48:30 +02:00
<h4 class="name" id="hasChildren"><span class="type-signature"></span>hasChildren<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-06-29 20:54:58 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line191">line 191</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
API docs updates
2019-12-03 22:53:17 +01:00
<span class="param-type">boolean</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<h4 class="name" id="hasLabel"><span class="type-signature"></span>hasLabel<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
updated API docs to reflect changes in link/image handling
2018-11-08 23:49:44 +01:00
API docs updates
2019-12-03 22:53:17 +01:00
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<th>Attributes</th>
API docs updates
2019-12-03 22:53:17 +01: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>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<td class="attributes">
</td>
API docs updates
2019-12-03 22:53:17 +01:00
<td class="description last">label name</td>
</tr>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">label value</td>
</tr>
API docs updates
2019-12-03 22:53:17 +01:00
</tbody>
</table>
updated API docs to reflect changes in link/image handling
2018-11-08 23:49:44 +01:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line480">line 480</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
updated API docs to reflect changes in link/image handling
2018-11-08 23:49:44 +01:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
updated API docs to reflect changes in link/image handling
2018-11-08 23:49:44 +01:00
<h5>Returns:</h5>
<div class="param-desc">
API docs updates
2019-12-03 22:53:17 +01:00
true if label exists (including inherited)
updated API docs to reflect changes in link/image handling
2018-11-08 23:49:44 +01:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
updated API docs
2020-09-30 22:48:30 +02:00
<span class="param-type">boolean</span>
updated API docs to reflect changes in link/image handling
2018-11-08 23:49:44 +01:00
</dd>
</dl>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<h4 class="name" id="hasOwnedAttribute"><span class="type-signature"></span>hasOwnedAttribute<span class="signature">(type, name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<th>Attributes</th>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<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>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<td class="attributes">
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<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>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<td class="attributes">
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<td class="description last">attribute name</td>
</tr>
<tr>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<td class="name"><code>value</code></td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<td class="type">
<span class="param-type">string</span>
</td>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<td class="attributes">
&lt;optional><br>
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<td class="description last">attribute value</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line571">line 571</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<div class="param-desc">
API docs updates
2019-12-03 22:53:17 +01:00
true if note has an attribute with given type and name (excluding inherited)
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
updated API docs
2020-09-30 22:48:30 +02:00
<span class="param-type">boolean</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<h4 class="name" id="hasOwnedLabel"><span class="type-signature"></span>hasOwnedLabel<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<th>Attributes</th>
API docs updates
2019-12-03 22:53:17 +01: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>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<td class="attributes">
</td>
API docs updates
2019-12-03 22:53:17 +01:00
<td class="description last">label name</td>
</tr>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">label value</td>
</tr>
API docs updates
2019-12-03 22:53:17 +01:00
</tbody>
</table>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line501">line 501</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
<h5>Returns:</h5>
<div class="param-desc">
API docs updates
2019-12-03 22:53:17 +01:00
true if label exists (excluding inherited)
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
updated API docs
2020-09-30 22:48:30 +02:00
<span class="param-type">boolean</span>
new frontend API - getCurrentNoteContent and onNoteChange
2018-09-03 16:05:28 +02:00
</dd>
</dl>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<h4 class="name" id="hasOwnedRelation"><span class="type-signature"></span>hasOwnedRelation<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<th>Attributes</th>
added jsdocs generated pages
2018-08-29 20:44:35 +02: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>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<td class="attributes">
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs updates
2019-12-03 22:53:17 +01:00
<td class="description last">relation name</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</tr>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">relation value</td>
</tr>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line515">line 515</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<div class="param-desc">
API docs updates
2019-12-03 22:53:17 +01:00
true if relation exists (excluding inherited)
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
updated API docs
2020-09-30 22:48:30 +02:00
<span class="param-type">boolean</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<h4 class="name" id="hasRelation"><span class="type-signature"></span>hasRelation<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<th>Attributes</th>
added jsdocs generated pages
2018-08-29 20:44:35 +02: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>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
<td class="attributes">
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<td class="description last">relation name</td>
</tr>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
API docs
2023-06-29 20:54:58 +02:00
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;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>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line508">line 508</a>
API docs
2023-06-29 20:54:58 +02:00
</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">boolean</span>
</dd>
</dl>
<h4 class="name" id="hasStringContent"><span class="type-signature"></span>hasStringContent<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
no need to create template relation if there is already one owned
2022-06-19 14:06:00 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line305">line 305</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h5>Returns:</h5>
<div class="param-desc">
API docs
2023-06-29 20:54:58 +02:00
true if the note has string content (not binary)
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
updated API docs
2020-09-30 22:48:30 +02:00
<span class="param-type">boolean</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dd>
</dl>
small script API additions
2019-11-27 23:07:10 +01:00
updated API docs
2020-09-30 22:48:30 +02:00
<h4 class="name" id="isDescendantOfNote"><span class="type-signature"></span>isDescendantOfNote<span class="signature">(ancestorNoteId)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
small script API additions
2019-11-27 23:07:10 +01: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>ancestorNoteId</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1262">line 1262</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
small script API additions
2019-11-27 23:07:10 +01:00
</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>
updated API docs
2020-09-30 22:48:30 +02:00
<span class="param-type">boolean</span>
small script API additions
2019-11-27 23:07:10 +01:00
</dd>
</dl>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
update docs
2023-02-17 16:15:58 +01:00
<h4 class="name" id="isHiddenCompletely"><span class="type-signature"></span>isHiddenCompletely<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1240">line 1240</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
boolean - true if there's no non-hidden path, note is not cloned to the visible tree
</div>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h4 class="name" id="isHtml"><span class="type-signature"></span>isHtml<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line288">line 288</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<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>
update docs
2023-02-17 16:15:58 +01:00
<h4 class="name" id="isImage"><span class="type-signature"></span>isImage<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>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line294">line 294</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if this note is an image
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h4 class="name" id="isJavaScript"><span class="type-signature"></span>isJavaScript<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line280">line 280</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<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"> &rarr; {boolean}</span></h4>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line275">line 275</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<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>
script api docs
2023-05-31 14:00:37 +02:00
<h4 class="name" id="isLabelTruthy"><span class="type-signature"></span>isLabelTruthy<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">label name</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line486">line 486</a>
script api docs
2023-05-31 14:00:37 +02:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if label exists (including inherited) and does not have "false" value.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<h4 class="name" id="isRoot"><span class="type-signature"></span>isRoot<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line270">line 270</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<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>
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="isStringNote"><span class="type-signature"></span>isStringNote<span class="signature">()</span><span class="type-signature"></span></h4>
update API docs
2019-02-20 22:24:51 +01:00
<dl class="details">
API docs
2023-06-29 20:54:58 +02:00
<dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>use hasStringContent() instead</li></ul></dd>
update API docs
2019-02-20 22:24:51 +01:00
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line300">line 300</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
update API docs
2019-02-20 22:24:51 +01:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
update API docs
2019-02-20 22:24:51 +01:00
fix docs
2022-04-16 00:17:32 +02:00
<h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDeleted<span class="signature">(deleteId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Mark the entity as (soft) deleted. It will be completely erased later.
moving `deleteNote` and `deleteBranch` into entities to make them accessible to scripts, #2792
2022-04-19 23:06:46 +02:00
API docs
2023-06-29 20:54:58 +02:00
This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
fix docs
2022-04-16 00:17:32 +02:00
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>deleteId</code></td>
<td class="type">
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
docs updated
2023-01-03 13:54:27 +01:00
<a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
fix docs
2022-04-16 00:17:32 +02:00
</li></ul></dd>
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-08-10 13:40:26 +02:00
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line263">line 263</a>
</li></ul></dd>
</dl>
<h4 class="name" id="putEntityChange"><span class="type-signature">(protected) </span>putEntityChange<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractBeccaEntity.html#putEntityChange">AbstractBeccaEntity#putEntityChange</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line64">line 64</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fix docs
2022-04-16 00:17:32 +02:00
</dl>
update API docs
2019-02-20 22:24:51 +01:00
updated API docs
2020-09-30 22:48:30 +02:00
<h4 class="name" id="removeAttribute"><span class="type-signature"></span>removeAttribute<span class="signature">(type, name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<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">
&lt;optional><br>
</td>
<td class="description last">attribute value (optional)</td>
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1306">line 1306</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2020-09-30 22:48:30 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2020-09-30 22:48:30 +02:00
<h4 class="name" id="removeLabel"><span class="type-signature"></span>removeLabel<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2020-09-30 22:48:30 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<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">
&lt;optional><br>
</td>
<td class="description last">label value</td>
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1422">line 1422</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2020-09-30 22:48:30 +02:00
<h4 class="name" id="removeRelation"><span class="type-signature"></span>removeRelation<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<div class="description">
API docs
2023-07-15 12:07:45 +02:00
Remove the relation name-value pair, if it exists.
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</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">
&lt;optional><br>
</td>
<td class="description last">relation value (noteId)</td>
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1430">line 1430</a>
API docs
2023-06-29 20:54:58 +02:00
</li></ul></dd>
</dl>
<h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> &rarr; {this}</span></h4>
<div class="description">
Saves entity - executes SQL, but doesn't commit the transaction on its own
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line85">line 85</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">this</span>
</dd>
</dl>
<h4 class="name" id="saveAttachment"><span class="type-signature"></span>saveAttachment<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BAttachment.html">BAttachment</a>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1638">line 1638</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
API docs
2023-06-29 20:54:58 +02:00
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="BAttachment.html">BAttachment</a></span>
</dd>
</dl>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
fix docs
2022-04-16 00:17:32 +02:00
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="saveRevision"><span class="type-signature"></span>saveRevision<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BRevision.html">BRevision</a>|null}</span></h4>
fix docs
2022-04-16 00:17:32 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1590">line 1590</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
fix docs
2022-04-16 00:17:32 +02:00
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
API docs
2023-06-29 20:54:58 +02:00
<span class="param-type"><a href="BRevision.html">BRevision</a></span>
|
<span class="param-type">null</span>
fix docs
2022-04-16 00:17:32 +02:00
</dd>
</dl>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="setAttribute"><span class="type-signature"></span>setAttribute<span class="signature">(type, name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"></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>
expose ability to create note revisions in backend API #2890
2022-06-02 17:25:58 +02:00
API docs
2023-06-29 20:54:58 +02:00
<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>
expose ability to create note revisions in backend API #2890
2022-06-02 17:25:58 +02:00
API docs
2023-06-29 20:54:58 +02:00
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
expose ability to create note revisions in backend API #2890
2022-06-02 17:25:58 +02:00
API docs
2023-06-29 20:54:58 +02:00
</td>
expose ability to create note revisions in backend API #2890
2022-06-02 17:25:58 +02:00
API docs
2023-06-29 20:54:58 +02:00
<td class="attributes">
&lt;optional><br>
expose ability to create note revisions in backend API #2890
2022-06-02 17:25:58 +02:00
API docs
2023-06-29 20:54:58 +02:00
expose ability to create note revisions in backend API #2890
2022-06-02 17:25:58 +02:00
API docs
2023-06-29 20:54:58 +02:00
</td>
expose ability to create note revisions in backend API #2890
2022-06-02 17:25:58 +02:00
API docs
2023-06-29 20:54:58 +02:00
expose ability to create note revisions in backend API #2890
2022-06-02 17:25:58 +02:00
API docs
2023-06-29 20:54:58 +02:00
<td class="description last">attribute value (optional)</td>
</tr>
expose ability to create note revisions in backend API #2890
2022-06-02 17:25:58 +02:00
API docs
2023-06-29 20:54:58 +02:00
</tbody>
</table>
expose ability to create note revisions in backend API #2890
2022-06-02 17:25:58 +02:00
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1275">line 1275</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
expose ability to create note revisions in backend API #2890
2022-06-02 17:25:58 +02:00
</dl>
API docs
2023-06-29 20:54:58 +02:00
<h4 class="name" id="setContent"><span class="type-signature"></span>setContent<span class="signature">(content, opts<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02: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>
API docs
2023-06-29 20:54:58 +02:00
<td class="name"><code>content</code></td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<td class="type">
API docs
2023-06-29 20:54:58 +02:00
</td>
<td class="attributes">
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs
2023-06-29 20:54:58 +02:00
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
<span class="param-type">object</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</td>
<td class="attributes">
API docs
2023-06-29 20:54:58 +02:00
&lt;optional><br>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</td>
API docs
2023-06-29 20:54:58 +02:00
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs
2023-06-29 20:54:58 +02:00
<tbody>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<tr>
API docs
2023-06-29 20:54:58 +02:00
<td class="name"><code>forceSave</code></td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<td class="type">
API docs
2023-06-29 20:54:58 +02:00
<span class="param-type">object</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</td>
<td class="attributes">
API docs
2023-06-29 20:54:58 +02:00
&lt;optional><br>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</td>
API docs
2023-06-29 20:54:58 +02:00
<td class="default">
false
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs
2023-06-29 20:54:58 +02:00
<td class="description last">will also save this BNote entity</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</tr>
<tr>
API docs
2023-06-29 20:54:58 +02:00
<td class="name"><code>forceFrontendReload</code></td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<td class="type">
API docs
2023-06-29 20:54:58 +02:00
<span class="param-type">object</span>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
API docs
2023-06-29 20:54:58 +02:00
<td class="default">
false
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
API docs
2023-06-29 20:54:58 +02:00
<td class="description last">override frontend heuristics on when to reload, instruct to reload</td>
</tr>
</tbody>
</table>
</td>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line243">line 243</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
update API docs
2019-02-20 22:24:51 +01:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
update API docs
2019-02-20 22:24:51 +01:00
updated API docs
2020-09-30 22:48:30 +02:00
<h4 class="name" id="setLabel"><span class="type-signature"></span>setLabel<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<div class="description">
uploading new image revisions, WIP
2019-11-08 22:34:30 +01:00
Update's given label's value or creates it if it doesn't exist
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</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">
&lt;optional><br>
</td>
<td class="description last">label value</td>
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1406">line 1406</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
various javaDoc improvements
2021-04-07 22:01:52 +02:00
<h4 class="name" id="setRelation"><span class="type-signature"></span>setRelation<span class="signature">(name, value)</span><span class="type-signature"></span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<div class="description">
uploading new image revisions, WIP
2019-11-08 22:34:30 +01:00
Update's given relation's value or creates it if it doesn't exist
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</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="description last">relation value (noteId)</td>
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1414">line 1414</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2020-09-30 22:48:30 +02:00
<h4 class="name" id="toggleAttribute"><span class="type-signature"></span>toggleAttribute<span class="signature">(type, enabled, name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<div class="description">
API docs
2023-07-15 12:07:45 +02:00
Based on enabled, the attribute is either set or removed.
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</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">
&lt;optional><br>
</td>
<td class="description last">attribute value (optional)</td>
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1373">line 1373</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2020-09-30 22:48:30 +02:00
<h4 class="name" id="toggleLabel"><span class="type-signature"></span>toggleLabel<span class="signature">(enabled, name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<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">
&lt;optional><br>
</td>
<td class="description last">label value (optional)</td>
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1389">line 1389</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
updated API docs
2020-09-30 22:48:30 +02:00
<h4 class="name" id="toggleRelation"><span class="type-signature"></span>toggleRelation<span class="signature">(enabled, name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
<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">
&lt;optional><br>
</td>
<td class="description last">relation value (noteId)</td>
</tr>
</tbody>
</table>
<dl class="details">
update docs
2023-02-17 16:15:58 +01:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
API docs
2023-09-23 00:04:32 +02:00
<a href="becca_entities_bnote.js.html">becca/entities/bnote.js</a>, <a href="becca_entities_bnote.js.html#line1398">line 1398</a>
update docs
2023-02-17 16:15:58 +01:00
</li></ul></dd>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</dl>
using dynamic import for dialogs and widgets to speed up initial load
2019-08-20 21:40:47 +02:00
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</article>
</section>
</div>
<nav>
API docs
2023-06-29 20:54:58 +02:00
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</nav>
<br class="clear">
<footer>
script api docs
2023-05-31 14:00:37 +02:00
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
added jsdocs generated pages
2018-08-29 20:44:35 +02:00
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in New Issue Copy Permalink