trilium/docs/backend_api/Attribute.html

1035 lines
10 KiB
HTML
Raw Normal View History

2018-08-30 02:44:35 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Attribute</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Attribute</h1>
<section>
<header>
2019-11-17 02:07:32 +08:00
<h2><span class="attribs"><span class="type-signature"></span></span>Attribute<span class="signature">()</span><span class="type-signature"></span></h2>
2018-08-30 02:44:35 +08:00
<div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair)
and relation (representing named relationship between source and target note)</div>
2018-08-30 02:44:35 +08:00
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
2019-11-17 02:07:32 +08:00
<h4 class="name" id="Attribute"><span class="type-signature"></span>new Attribute<span class="signature">()</span><span class="type-signature"></span></h4>
2018-08-30 02:44:35 +08:00
2019-11-17 02:07:32 +08:00
<dl class="details">
2019-11-17 02:07:32 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line13">line 13</a>
</li></ul></dd>
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
</dl>
2018-08-30 02:44:35 +08:00
</div>
2018-08-30 02:44:35 +08:00
<h3 class="subsection-title">Members</h3>
2018-08-30 02:44:35 +08:00
<h4 class="name" id="attributeId"><span class="type-signature"></span>attributeId<span class="type-signature"> :string</span></h4>
2018-08-30 02:44:35 +08:00
<h5>Type:</h5>
<ul>
<li>
2018-08-30 02:44:35 +08:00
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line44">line 44</a>
</li></ul></dd>
2018-08-30 02:44:35 +08:00
</dl>
2018-08-30 02:44:35 +08:00
<h4 class="name" id="isInheritable"><span class="type-signature"></span>isInheritable<span class="type-signature"> :boolean</span></h4>
2018-08-30 02:44:35 +08:00
<h5>Type:</h5>
<ul>
<li>
2018-08-30 02:44:35 +08:00
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line56">line 56</a>
</li></ul></dd>
</dl>
2018-08-30 02:44:35 +08:00
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
2018-08-30 02:44:35 +08:00
<h5>Type:</h5>
<ul>
<li>
2018-08-30 02:44:35 +08:00
<span class="param-type">string</span>
</li>
</ul>
2018-08-30 02:44:35 +08:00
<dl class="details">
2018-08-30 02:44:35 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
2018-08-30 02:44:35 +08:00
<h4 class="name" id="noteId"><span class="type-signature"></span>noteId<span class="type-signature"> :string</span></h4>
2018-08-30 02:44:35 +08:00
<h5>Type:</h5>
<ul>
<li>
2018-08-30 02:44:35 +08:00
<span class="param-type">string</span>
</li>
</ul>
2018-08-30 02:44:35 +08:00
<dl class="details">
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line46">line 46</a>
</li></ul></dd>
2018-08-30 02:44:35 +08:00
</dl>
2018-08-30 02:44:35 +08:00
<h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"> :int</span></h4>
2018-08-30 02:44:35 +08:00
<h5>Type:</h5>
<ul>
<li>
2018-08-30 02:44:35 +08:00
<span class="param-type">int</span>
</li>
</ul>
2018-08-30 02:44:35 +08:00
<dl class="details">
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
2020-02-02 18:44:08 +08:00
<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
2020-02-02 18:44:08 +08:00
<h5>Type:</h5>
<ul>
<li>
2020-02-02 18:44:08 +08:00
<span class="param-type">string</span>
</li>
</ul>
2020-02-02 18:44:08 +08:00
<dl class="details">
2020-02-02 18:44:08 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line48">line 48</a>
</li></ul></dd>
2018-08-30 02:44:35 +08:00
</dl>
2018-08-30 02:44:35 +08:00
<h4 class="name" id="utcDateModified"><span class="type-signature"></span>utcDateModified<span class="type-signature"> :string</span></h4>
2018-08-30 02:44:35 +08:00
<h5>Type:</h5>
<ul>
<li>
2018-08-30 02:44:35 +08:00
<span class="param-type">string</span>
2018-08-30 02:44:35 +08:00
</li>
</ul>
2018-08-30 02:44:35 +08:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line58">line 58</a>
2018-08-30 02:44:35 +08:00
</li></ul></dd>
</dl>
<h4 class="name" id="value"><span class="type-signature"></span>value<span class="type-signature"> :string</span></h4>
2018-08-30 02:44:35 +08:00
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
2018-08-30 02:44:35 +08:00
</li>
</ul>
2018-08-30 02:44:35 +08:00
<dl class="details">
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
2018-08-30 02:44:35 +08:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line54">line 54</a>
</li></ul></dd>
2018-08-30 02:44:35 +08:00
</dl>
<h3 class="subsection-title">Methods</h3>
2020-10-01 04:48:30 +08:00
<h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line112">line 112</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
2020-10-01 04:48:30 +08:00
<span class="param-type"><a href="Note.html">Note</a></span>
|
<span class="param-type">null</span>
</dd>
</dl>
2020-10-01 04:48:30 +08:00
<h4 class="name" id="getTargetNote"><span class="type-signature"></span>getTargetNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line119">line 119</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
2020-10-01 04:48:30 +08:00
<span class="param-type"><a href="Note.html">Note</a></span>
|
<span class="param-type">null</span>
</dd>
</dl>
<h4 class="name" id="isDefinition"><span class="type-signature"></span>isDefinition<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line134">line 134</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
2018-08-30 02:44:35 +08:00
</article>
</section>
</div>
<nav>
2022-01-15 02:53:59 +08: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="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
2018-08-30 02:44:35 +08:00
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a>
2018-08-30 02:44:35 +08:00
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>