Attribute.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: Attribute</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: Attribute</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>Attribute<span class="signature">()</span><span class="type-signature"></span></h2>
  20. <div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair)
  21. and relation (representing named relationship between source and target note)</div>
  22. </header>
  23. <article>
  24. <div class="container-overview">
  25. <h2>Constructor</h2>
  26. <h4 class="name" id="Attribute"><span class="type-signature"></span>new Attribute<span class="signature">()</span><span class="type-signature"></span></h4>
  27. <dl class="details">
  28. <dt class="tag-source">Source:</dt>
  29. <dd class="tag-source"><ul class="dummy"><li>
  30. <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line13">line 13</a>
  31. </li></ul></dd>
  32. </dl>
  33. </div>
  34. <h3 class="subsection-title">Members</h3>
  35. <h4 class="name" id="attributeId"><span class="type-signature"></span>attributeId<span class="type-signature"> :string</span></h4>
  36. <h5>Type:</h5>
  37. <ul>
  38. <li>
  39. <span class="param-type">string</span>
  40. </li>
  41. </ul>
  42. <dl class="details">
  43. <dt class="tag-source">Source:</dt>
  44. <dd class="tag-source"><ul class="dummy"><li>
  45. <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line44">line 44</a>
  46. </li></ul></dd>
  47. </dl>
  48. <h4 class="name" id="isInheritable"><span class="type-signature"></span>isInheritable<span class="type-signature"> :boolean</span></h4>
  49. <h5>Type:</h5>
  50. <ul>
  51. <li>
  52. <span class="param-type">boolean</span>
  53. </li>
  54. </ul>
  55. <dl class="details">
  56. <dt class="tag-source">Source:</dt>
  57. <dd class="tag-source"><ul class="dummy"><li>
  58. <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line56">line 56</a>
  59. </li></ul></dd>
  60. </dl>
  61. <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
  62. <h5>Type:</h5>
  63. <ul>
  64. <li>
  65. <span class="param-type">string</span>
  66. </li>
  67. </ul>
  68. <dl class="details">
  69. <dt class="tag-source">Source:</dt>
  70. <dd class="tag-source"><ul class="dummy"><li>
  71. <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line50">line 50</a>
  72. </li></ul></dd>
  73. </dl>
  74. <h4 class="name" id="noteId"><span class="type-signature"></span>noteId<span class="type-signature"> :string</span></h4>
  75. <h5>Type:</h5>
  76. <ul>
  77. <li>
  78. <span class="param-type">string</span>
  79. </li>
  80. </ul>
  81. <dl class="details">
  82. <dt class="tag-source">Source:</dt>
  83. <dd class="tag-source"><ul class="dummy"><li>
  84. <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line46">line 46</a>
  85. </li></ul></dd>
  86. </dl>
  87. <h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"> :int</span></h4>
  88. <h5>Type:</h5>
  89. <ul>
  90. <li>
  91. <span class="param-type">int</span>
  92. </li>
  93. </ul>
  94. <dl class="details">
  95. <dt class="tag-source">Source:</dt>
  96. <dd class="tag-source"><ul class="dummy"><li>
  97. <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line52">line 52</a>
  98. </li></ul></dd>
  99. </dl>
  100. <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
  101. <h5>Type:</h5>
  102. <ul>
  103. <li>
  104. <span class="param-type">string</span>
  105. </li>
  106. </ul>
  107. <dl class="details">
  108. <dt class="tag-source">Source:</dt>
  109. <dd class="tag-source"><ul class="dummy"><li>
  110. <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line48">line 48</a>
  111. </li></ul></dd>
  112. </dl>
  113. <h4 class="name" id="utcDateModified"><span class="type-signature"></span>utcDateModified<span class="type-signature"> :string</span></h4>
  114. <h5>Type:</h5>
  115. <ul>
  116. <li>
  117. <span class="param-type">string</span>
  118. </li>
  119. </ul>
  120. <dl class="details">
  121. <dt class="tag-source">Source:</dt>
  122. <dd class="tag-source"><ul class="dummy"><li>
  123. <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line58">line 58</a>
  124. </li></ul></dd>
  125. </dl>
  126. <h4 class="name" id="value"><span class="type-signature"></span>value<span class="type-signature"> :string</span></h4>
  127. <h5>Type:</h5>
  128. <ul>
  129. <li>
  130. <span class="param-type">string</span>
  131. </li>
  132. </ul>
  133. <dl class="details">
  134. <dt class="tag-source">Source:</dt>
  135. <dd class="tag-source"><ul class="dummy"><li>
  136. <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line54">line 54</a>
  137. </li></ul></dd>
  138. </dl>
  139. <h3 class="subsection-title">Methods</h3>
  140. <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>
  141. <dl class="details">
  142. <dt class="tag-source">Source:</dt>
  143. <dd class="tag-source"><ul class="dummy"><li>
  144. <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line112">line 112</a>
  145. </li></ul></dd>
  146. </dl>
  147. <h5>Returns:</h5>
  148. <dl>
  149. <dt>
  150. Type
  151. </dt>
  152. <dd>
  153. <span class="param-type"><a href="Note.html">Note</a></span>
  154. |
  155. <span class="param-type">null</span>
  156. </dd>
  157. </dl>
  158. <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>
  159. <dl class="details">
  160. <dt class="tag-source">Source:</dt>
  161. <dd class="tag-source"><ul class="dummy"><li>
  162. <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line119">line 119</a>
  163. </li></ul></dd>
  164. </dl>
  165. <h5>Returns:</h5>
  166. <dl>
  167. <dt>
  168. Type
  169. </dt>
  170. <dd>
  171. <span class="param-type"><a href="Note.html">Note</a></span>
  172. |
  173. <span class="param-type">null</span>
  174. </dd>
  175. </dl>
  176. <h4 class="name" id="isDefinition"><span class="type-signature"></span>isDefinition<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  177. <dl class="details">
  178. <dt class="tag-source">Source:</dt>
  179. <dd class="tag-source"><ul class="dummy"><li>
  180. <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line134">line 134</a>
  181. </li></ul></dd>
  182. </dl>
  183. <h5>Returns:</h5>
  184. <dl>
  185. <dt>
  186. Type
  187. </dt>
  188. <dd>
  189. <span class="param-type">boolean</span>
  190. </dd>
  191. </dl>
  192. </article>
  193. </section>
  194. </div>
  195. <nav>
  196. <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="ApiToken.html">ApiToken</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="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>
  197. </nav>
  198. <br class="clear">
  199. <footer>
  200. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a>
  201. </footer>
  202. <script> prettyPrint(); </script>
  203. <script src="scripts/linenumber.js"> </script>
  204. </body>
  205. </html>