2018-08-29 20:44:35 +02:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > JSDoc: Class: Note< / title >
< script src = "scripts/prettify/prettify.js" > < / script >
< script src = "scripts/prettify/lang-css.js" > < / script >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/prettify-tomorrow.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/jsdoc-default.css" >
< / head >
< body >
< div id = "main" >
< h1 class = "page-title" > Class: Note< / h1 >
< section >
< header >
2021-11-10 21:30:54 +01:00
< h2 > < span class = "attribs" > < span class = "type-signature" > < / span > < / span > Note< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h2 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< div class = "class-description" > Trilium's main entity which can represent text note, image, code note, file attachment etc.< / div >
2018-08-29 20:44:35 +02:00
< / header >
< article >
< div class = "container-overview" >
< h2 > Constructor< / h2 >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "Note" > < span class = "type-signature" > < / span > new Note< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line24" > line 24< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / dl >
< / div >
2022-04-16 00:17:32 +02:00
< h3 class = "subsection-title" > Extends< / h3 >
< ul >
< li > < a href = "AbstractEntity.html" > AbstractEntity< / a > < / li >
< / ul >
2021-11-10 21:30:54 +01:00
< h3 class = "subsection-title" > Members< / h3 >
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 >
2021-11-10 21:30:54 +01:00
< dl class = "details" >
2022-06-19 14:06:00 +02:00
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
< a href = "AbstractEntity.html#becca" > AbstractEntity#becca< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-06-19 14:06:00 +02:00
< a href = "becca_entities_abstract_entity.js.html" > becca/entities/abstract_entity.js< / a > , < a href = "becca_entities_abstract_entity.js.html#line50" > line 50< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "dateCreated" > < span class = "type-signature" > < / span > dateCreated< span class = "type-signature" > :string< / span > < / h4 >
< h5 > Type:< / h5 >
< ul >
< li >
< 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 >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line68" > line 68< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "dateModified" > < span class = "type-signature" > < / span > dateModified< span class = "type-signature" > :string< / span > < / h4 >
< h5 > Type:< / h5 >
< ul >
< li >
< 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 >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line70" > line 70< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / dl >
< 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 >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line86" > line 86< / a >
< / li > < / ul > < / dd >
< / 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line76" > line 76< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line81" > line 81< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line62" > line 62< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line66" > line 66< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line58" > line 58< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / dl >
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 >
2021-11-10 21:30:54 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
< 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 >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line60" > line 60< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / dl >
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 >
2021-11-10 21:30:54 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
2022-06-19 14:06:00 +02:00
< span class = "param-type" > string< / span >
2021-11-10 21:30:54 +01:00
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line64" > line 64< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / dl >
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 >
2021-11-10 21:30:54 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
2022-06-19 14:06:00 +02:00
< span class = "param-type" > string< / span >
2021-11-10 21:30:54 +01:00
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line72" > line 72< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / dl >
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 >
2021-11-10 21:30:54 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
2022-06-19 14:06:00 +02:00
< span class = "param-type" > string< / span >
2021-11-10 21:30:54 +01:00
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line74" > line 74< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / dl >
2022-06-19 14:06:00 +02:00
< h3 class = "subsection-title" > Methods< / h3 >
2021-11-10 21:30:54 +01:00
2022-06-19 14:06:00 +02:00
2021-11-10 21:30:54 +01:00
2022-06-19 14:06:00 +02:00
2022-08-27 13:45:22 -07:00
< h4 class = "name" id = "addAttribute" > < span class = "type-signature" > < / span > addAttribute< span class = "signature" > (type, name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {< a href = "Attribute.html" > Attribute< / a > }< / span > < / h4 >
2022-06-19 14:06:00 +02:00
2021-11-10 21:30:54 +01:00
2022-06-19 14:06:00 +02:00
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< div class = "description" >
Adds a new attribute to this note. The attribute is saved and returned.
See addLabel, addRelation for more specific methods.
< / div >
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
< h5 > Parameters:< / h5 >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< th > Type< / th >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< th > Attributes< / th >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< tbody >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< tr >
< td class = "name" > < code > type< / code > < / td >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< td class = "type" >
< span class = "param-type" > string< / span >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< / td >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< td class = "attributes" >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< / td >
< td class = "description last" > attribute type (label / relation)< / td >
< / tr >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< / td >
< td class = "attributes" >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
< / td >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< td class = "description last" > name of the attribute, not including the leading ~/#< / td >
< / tr >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< tr >
< td class = "name" > < code > value< / code > < / td >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< td class = "type" >
< span class = "param-type" > string< / span >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< / td >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< td class = "attributes" >
< optional>< br >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< / td >
< td class = "description last" > value of the attribute - text for labels, target note ID for relations; optional.< / td >
< / tr >
< / tbody >
< / table >
2021-11-10 21:30:54 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1177" > line 1177< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / dl >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2022-06-19 14:06:00 +02:00
< h5 > Returns:< / h5 >
2018-08-29 20:44:35 +02:00
2022-06-19 14:06:00 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Attribute.html" > Attribute< / a > < / span >
2021-11-10 21:30:54 +01:00
2022-06-19 14:06:00 +02:00
< / dd >
< / dl >
2021-11-10 21:30:54 +01:00
2022-06-19 14:06:00 +02:00
2021-11-10 21:30:54 +01:00
2022-06-19 14:06:00 +02:00
< h4 class = "name" id = "addEntityChange" > < span class = "type-signature" > (protected) < / span > addEntityChange< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2021-11-10 21:30:54 +01:00
< dl class = "details" >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2022-06-19 14:06:00 +02:00
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
< a href = "AbstractEntity.html#addEntityChange" > AbstractEntity#addEntityChange< / a >
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-06-19 14:06:00 +02:00
< a href = "becca_entities_abstract_entity.js.html" > becca/entities/abstract_entity.js< / a > , < a href = "becca_entities_abstract_entity.js.html#line59" > line 59< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / dl >
2022-08-27 13:45:22 -07:00
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< h4 class = "name" id = "addLabel" > < span class = "type-signature" > < / span > addLabel< span class = "signature" > (name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {< a href = "Attribute.html" > Attribute< / a > }< / span > < / h4 >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< div class = "description" >
Adds a new label to this note. The label attribute is saved and returned.
< / div >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< h5 > Parameters:< / h5 >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< th > Type< / th >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< th > Attributes< / th >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< tbody >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< td class = "type" >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
2021-11-10 21:30:54 +01:00
< span class = "param-type" > string< / span >
2022-08-27 13:45:22 -07:00
< / td >
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
< td class = "attributes" >
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
< / td >
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
< td class = "description last" > name of the label, not including the leading #< / td >
< / tr >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
< tr >
< td class = "name" > < code > value< / code > < / td >
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< td class = "type" >
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
< / td >
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
< td class = "attributes" >
< optional>< br >
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< / td >
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
< td class = "description last" > text value of the label; optional< / td >
< / tr >
< / tbody >
< / table >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< dl class = "details" >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1198" > line 1198< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< / dl >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
< h5 > Returns:< / h5 >
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
2018-08-29 20:44:35 +02:00
2020-02-02 11:44:08 +01:00
2022-08-27 13:45:22 -07:00
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Attribute.html" > Attribute< / a > < / span >
2020-02-02 11:44:08 +01:00
2022-08-27 13:45:22 -07:00
< / dd >
< / dl >
2020-02-02 11:44:08 +01:00
2021-11-10 21:30:54 +01:00
2020-02-02 11:44:08 +01:00
2022-08-27 13:45:22 -07:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2022-08-27 13:45:22 -07:00
< h4 class = "name" id = "addRelation" > < span class = "type-signature" > < / span > addRelation< span class = "signature" > (name, value)< / span > < span class = "type-signature" > → {< a href = "Attribute.html" > Attribute< / a > }< / span > < / h4 >
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2022-08-27 13:45:22 -07:00
< div class = "description" >
Adds a new relation to this note. The relation attribute is saved and
returned.
< / div >
2018-08-29 20:44:35 +02:00
2019-03-14 20:49:10 +01:00
2022-08-27 13:45:22 -07:00
< h5 > Parameters:< / h5 >
2021-11-10 21:30:54 +01:00
2019-03-14 20:49:10 +01:00
2022-08-27 13:45:22 -07:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
2021-11-10 21:30:54 +01:00
2019-03-14 20:49:10 +01:00
2022-08-27 13:45:22 -07:00
< th > Type< / th >
2019-03-14 20:49:10 +01:00
2022-08-27 13:45:22 -07:00
2019-03-14 20:49:10 +01:00
2022-08-27 13:45:22 -07:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2021-11-10 21:30:54 +01:00
2019-03-14 20:49:10 +01:00
2022-08-27 13:45:22 -07:00
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > name of the relation, not including the leading ~< / td >
< / tr >
2019-03-14 20:49:10 +01:00
2022-08-27 13:45:22 -07:00
< tr >
< td class = "name" > < code > value< / code > < / td >
2019-03-14 20:49:10 +01:00
2022-08-27 13:45:22 -07:00
< td class = "type" >
< span class = "param-type" > string< / span >
2019-03-14 20:49:10 +01:00
2022-08-27 13:45:22 -07:00
< / td >
2019-03-14 20:49:10 +01:00
2022-08-27 13:45:22 -07:00
2019-03-14 20:49:10 +01:00
2022-08-27 13:45:22 -07:00
2019-03-14 20:49:10 +01:00
2022-08-27 13:45:22 -07:00
< td class = "description last" > ID of the target note of the relation< / td >
< / tr >
2019-03-14 20:49:10 +01:00
2022-08-27 13:45:22 -07:00
< / tbody >
< / table >
2019-03-14 20:49:10 +01:00
2018-08-29 20:44:35 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1211" > line 1211< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2021-11-10 21:30:54 +01:00
< h5 > Returns:< / h5 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2022-08-27 13:45:22 -07:00
< span class = "param-type" > < a href = "Attribute.html" > Attribute< / a > < / span >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< / dd >
< / dl >
2018-08-29 20:44:35 +02:00
2022-06-19 14:06:00 +02:00
< h4 class = "name" id = "beforeSaving" > < span class = "type-signature" > (protected) < / span > beforeSaving< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2019-11-18 23:01:31 +01:00
2022-08-27 13:42:44 -07:00
2018-08-29 20:44:35 +02:00
2019-11-18 23:01:31 +01:00
< dl class = "details" >
2022-06-19 14:06:00 +02:00
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
< a href = "AbstractEntity.html#beforeSaving" > AbstractEntity#beforeSaving< / a >
< / li > < / ul > < / dd >
2019-11-18 23:01:31 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-06-19 14:06:00 +02:00
< a href = "becca_entities_abstract_entity.js.html" > becca/entities/abstract_entity.js< / a > , < a href = "becca_entities_abstract_entity.js.html#line18" > line 18< / a >
2022-08-27 13:42:44 -07:00
< / li > < / ul > < / dd >
< / dl >
2022-07-19 23:32:03 +02:00
< h4 class = "name" id = "cloneTo" > < span class = "type-signature" > < / span > cloneTo< span class = "signature" > (parentNoteId)< / span > < span class = "type-signature" > → {Object}< / span > < / h4 >
2022-08-27 13:42:44 -07:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2022-07-19 23:32:03 +02:00
< td class = "name" > < code > parentNoteId< / code > < / td >
2022-08-27 13:42:44 -07:00
< td class = "type" >
< / td >
2022-07-19 23:32:03 +02:00
< td class = "description last" > < / td >
2022-08-27 13:42:44 -07:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1296" > line 1296< / a >
2022-08-27 13:42:44 -07:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2022-07-19 23:32:03 +02:00
< span class = "param-type" > Object< / span >
2022-08-27 13:42:44 -07:00
< / dd >
< / dl >
2022-06-19 14:06:00 +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 >
2022-08-27 13:42:44 -07:00
< div class = "description" >
2022-06-19 14:06:00 +02:00
(Soft) delete a note and all its descendants.
2022-08-27 13:42:44 -07:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-06-19 14:06:00 +02:00
< th > Attributes< / th >
2022-08-27 13:42:44 -07:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2022-06-19 14:06:00 +02:00
< td class = "name" > < code > deleteId< / code > < / td >
2022-08-27 13:42:44 -07:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2022-06-19 14:06:00 +02:00
< td class = "attributes" >
< optional>< br >
< / td >
2022-08-27 13:42:44 -07:00
2022-06-19 14:06:00 +02:00
< td class = "description last" > optional delete identified< / td >
2022-08-27 13:42:44 -07:00
< / tr >
< tr >
2022-06-19 14:06:00 +02:00
< td class = "name" > < code > taskContext< / code > < / td >
2022-08-27 13:42:44 -07:00
< td class = "type" >
2022-06-19 14:06:00 +02:00
< span class = "param-type" > TaskContext< / span >
2022-08-27 13:42:44 -07:00
< / td >
2022-06-19 14:06:00 +02:00
< td class = "attributes" >
< optional>< br >
2019-03-14 20:49:10 +01:00
2022-06-19 14:06:00 +02:00
2019-03-14 20:49:10 +01:00
2022-06-19 14:06:00 +02:00
< / td >
2022-08-27 13:42:44 -07:00
2022-06-19 14:06:00 +02:00
< td class = "description last" > < / td >
2022-08-27 13:42:44 -07:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1310" > line 1310< / a >
2019-11-18 23:01:31 +01:00
< / li > < / ul > < / dd >
< / dl >
2018-08-29 20:44:35 +02:00
2019-11-18 23:01:31 +01:00
2018-08-29 20:44:35 +02:00
2019-11-18 23:01:31 +01:00
2018-08-29 20:44:35 +02:00
2019-11-18 23:01:31 +01:00
2018-08-29 20:44:35 +02:00
2022-06-19 14:06:00 +02:00
< h4 class = "name" id = "generateHash" > < span class = "type-signature" > (protected) < / span > generateHash< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2019-11-18 23:01:31 +01:00
< dl class = "details" >
2022-04-19 23:06:46 +02:00
2019-11-18 23:01:31 +01:00
2022-04-19 23:06:46 +02:00
2022-06-19 14:06:00 +02:00
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
< a href = "AbstractEntity.html#generateHash" > AbstractEntity#generateHash< / a >
< / li > < / ul > < / dd >
2022-04-19 23:06:46 +02:00
2019-11-18 23:01:31 +01:00
2022-04-19 23:06:46 +02:00
2019-11-18 23:01:31 +01:00
2022-04-19 23:06:46 +02:00
2019-11-18 23:01:31 +01:00
2022-04-19 23:06:46 +02:00
2019-11-18 23:01:31 +01:00
2022-04-19 23:06:46 +02:00
2019-11-18 23:01:31 +01:00
2022-04-19 23:06:46 +02:00
2019-11-18 23:01:31 +01:00
2022-04-19 23:06:46 +02:00
2019-11-18 23:01:31 +01:00
2022-04-19 23:06:46 +02:00
2019-11-18 23:01:31 +01:00
2022-04-19 23:06:46 +02:00
2019-11-18 23:01:31 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-06-19 14:06:00 +02:00
< a href = "becca_entities_abstract_entity.js.html" > becca/entities/abstract_entity.js< / a > , < a href = "becca_entities_abstract_entity.js.html#line30" > line 30< / a >
2019-11-18 23:01:31 +01:00
< / li > < / ul > < / dd >
2022-04-19 23:06:46 +02:00
2019-11-18 23:01:31 +01:00
2022-04-19 23:06:46 +02:00
2019-11-18 23:01:31 +01:00
2022-04-19 23:06:46 +02:00
2019-11-18 23:01:31 +01:00
< / dl >
2022-04-19 23:06:46 +02:00
2019-11-18 23:01:31 +01:00
2022-04-19 23:06:46 +02:00
2022-06-19 14:06:00 +02:00
2022-04-19 23:06:46 +02:00
2022-06-19 14:06:00 +02:00
< h4 class = "name" id = "generateIdIfNecessary" > < span class = "type-signature" > (protected) < / span > generateIdIfNecessary< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2022-04-19 23:06:46 +02:00
2022-06-19 14:06:00 +02:00
2022-04-19 23:06:46 +02:00
< dl class = "details" >
2022-06-19 14:06:00 +02:00
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
< a href = "AbstractEntity.html#generateIdIfNecessary" > AbstractEntity#generateIdIfNecessary< / a >
< / li > < / ul > < / dd >
2022-04-19 23:06:46 +02:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-06-19 14:06:00 +02:00
< a href = "becca_entities_abstract_entity.js.html" > becca/entities/abstract_entity.js< / a > , < a href = "becca_entities_abstract_entity.js.html#line23" > line 23< / a >
2022-04-19 23:06:46 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-11-18 23:01:31 +01:00
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getAllNotePaths" > < span class = "type-signature" > < / span > getAllNotePaths< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< Array.< string>>}< / span > < / h4 >
2019-11-23 22:56:35 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1092" > line 1092< / a >
2019-11-23 22:56:35 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
- array of notePaths (each represented by array of noteIds constituting the particular note path)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > Array.< Array.< string>>< / span >
2019-11-23 22:56:35 +01:00
< / dd >
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "getAncestors" > < span class = "type-signature" > < / span > getAncestors< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "Note.html" > Note< / a > >}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1008" > line 1008< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2021-11-10 21:30:54 +01:00
< span class = "param-type" > Array.< < a href = "Note.html" > Note< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "getAttribute" > < span class = "type-signature" > < / span > getAttribute< span class = "signature" > (type, name)< / span > < span class = "type-signature" > → {< a href = "Attribute.html" > Attribute< / a > }< / span > < / h4 >
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 >
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 >
2021-11-10 21:30:54 +01:00
< td class = "description last" > attribute type (label, relation, etc.)< / td >
2019-12-03 22:53:17 +01:00
< / tr >
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 >
2021-11-10 21:30:54 +01:00
< td class = "description last" > attribute name< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line600" > line 600< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
2018-12-22 22:28:49 +01:00
< div class = "param-desc" >
2021-11-10 21:30:54 +01:00
attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
2018-12-22 22:28:49 +01:00
< / div >
2018-08-29 20:44:35 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2021-11-10 21:30:54 +01:00
< span class = "param-type" > < a href = "Attribute.html" > Attribute< / a > < / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
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" > → {string|null}< / span > < / h4 >
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 >
2018-12-22 22:28:49 +01:00
< td class = "name" > < code > type< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2022-11-07 21:26:13 +01:00
< td class = "description last" > attribute type (label, relation, etc.)< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< tr >
2018-12-22 22:28:49 +01:00
< td class = "name" > < code > name< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2022-11-07 21:26:13 +01:00
< td class = "description last" > attribute name< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line611" > line 611< / a >
2018-12-22 22:28:49 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
attribute value of given type and name or null if no such attribute exists.
2021-11-10 21:30:54 +01:00
< / div >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2018-08-29 20:44:35 +02:00
2022-11-07 21:26:13 +01:00
< span class = "param-type" > string< / span >
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2022-11-07 21:26:13 +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" > → {Array.< < a href = "Attribute.html" > Attribute< / a > >}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< h5 > Parameters:< / h5 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< th > Type< / th >
2018-08-29 20:44:35 +02:00
2022-11-07 21:26:13 +01:00
< th > Attributes< / th >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< tbody >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< tr >
< td class = "name" > < code > type< / code > < / td >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
2018-08-29 20:44:35 +02:00
2022-11-07 21:26:13 +01:00
< / td >
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > (optional) attribute type to filter< / td >
2021-11-10 21:30:54 +01:00
< / tr >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
< / td >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > (optional) attribute name to filter< / td >
2021-11-10 21:30:54 +01:00
< / tr >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< / tbody >
< / table >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< dl class = "details" >
2018-09-03 16:05:28 +02:00
2018-12-22 22:28:49 +01:00
2018-09-03 16:05:28 +02:00
2018-12-22 22:28:49 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line374" > line 374< / a >
2018-12-22 22:28:49 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
2018-09-03 16:05:28 +02:00
2018-12-22 22:28:49 +01:00
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
all note's attributes, including inherited ones
2018-12-22 22:28:49 +01:00
< / div >
2018-09-03 16:05:28 +02:00
2018-12-22 22:28:49 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2018-09-03 16:05:28 +02:00
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Array.< < a href = "Attribute.html" > Attribute< / a > >< / span >
2020-09-30 22:48:30 +02:00
< / dd >
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "getBranches" > < span class = "type-signature" > < / span > getBranches< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "Branch.html" > Branch< / a > >}< / span > < / h4 >
2020-09-30 22:48:30 +02:00
< dl class = "details" >
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 >
2020-09-30 22:48:30 +02:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line172" > line 172< / a >
2020-09-30 22:48:30 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2021-11-10 21:30:54 +01:00
< span class = "param-type" > Array.< < a href = "Branch.html" > Branch< / a > >< / span >
2018-09-03 16:05:28 +02:00
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2018-09-03 16:05:28 +02:00
2018-12-22 22:28:49 +01:00
2018-09-03 16:05:28 +02:00
2018-12-22 22:28:49 +01:00
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "getChildBranches" > < span class = "type-signature" > < / span > getChildBranches< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "Branch.html" > Branch< / a > >}< / span > < / h4 >
2019-02-20 22:24:51 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line192" > line 192< / a >
2019-02-20 22:24:51 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2019-02-20 22:24:51 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2021-11-10 21:30:54 +01:00
< span class = "param-type" > Array.< < a href = "Branch.html" > Branch< / a > >< / span >
2019-02-20 22:24:51 +01:00
< / dd >
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "getChildNotes" > < span class = "type-signature" > < / span > getChildNotes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "Note.html" > Note< / a > >}< / span > < / h4 >
2018-12-22 22:28:49 +01:00
2018-09-03 16:05:28 +02:00
2018-08-29 20:44:35 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line182" > line 182< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2021-11-10 21:30:54 +01:00
< span class = "param-type" > Array.< < a href = "Note.html" > Note< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "getContent" > < span class = "type-signature" > < / span > getContent< span class = "signature" > ()< / span > < span class = "type-signature" > → {*}< / span > < / h4 >
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line206" > line 206< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2021-11-10 21:30:54 +01:00
< span class = "param-type" > *< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "getContentMetadata" > < span class = "type-signature" > < / span > getContentMetadata< span class = "signature" > ()< / span > < span class = "type-signature" > → {Object}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< dl class = "details" >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line240" > line 240< / a >
2018-12-22 22:28:49 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< / dl >
2018-08-29 20:44:35 +02:00
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2021-11-10 21:30:54 +01:00
< span class = "param-type" > Object< / span >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "getFlatText" > < span class = "type-signature" > < / span > getFlatText< span class = "signature" > ()< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< div class = "description" >
2021-11-10 21:30:54 +01:00
This is used for:
- fast searching
- note similarity evaluation
2018-12-22 22:28:49 +01:00
< / div >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line740" > line 740< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
2021-11-10 21:30:54 +01:00
< div class = "param-desc" >
- returns flattened textual representation of note, prefixes and attributes
< / div >
2018-08-29 20:44:35 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2021-11-10 21:30:54 +01:00
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getJsonContent" > < span class = "type-signature" > < / span > getJsonContent< span class = "signature" > ()< / span > < span class = "type-signature" > → {*}< / span > < / h4 >
2019-02-20 22:24:51 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line267" > line 267< / a >
2019-02-20 22:24:51 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2019-02-20 22:24:51 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > *< / span >
2019-02-20 22:24:51 +01:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getLabel" > < span class = "type-signature" > < / span > getLabel< span class = "signature" > (name)< / span > < span class = "type-signature" > → {< a href = "Attribute.html" > Attribute< / a > |null}< / span > < / h4 >
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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line541" > line 541< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
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 >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > < a href = "Attribute.html" > Attribute< / a > < / span >
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
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" > → {string|null}< / span > < / h4 >
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 >
2022-11-07 21:26:13 +01:00
< td class = "description last" > label name< / td >
2018-11-13 12:50:08 +01:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line565" > line 565< / a >
2018-11-13 12:50:08 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-11-13 12:50:08 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
label value if label exists, null otherwise
2018-11-13 12:50:08 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > string< / span >
|
< span class = "param-type" > null< / span >
2018-11-13 12:50:08 +01:00
< / dd >
< / dl >
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" > → {Array.< string>}< / span > < / h4 >
2018-09-03 16:05:28 +02:00
< h5 > Parameters:< / h5 >
2018-08-29 20:44:35 +02:00
2018-09-03 16:05:28 +02:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-11-07 21:26:13 +01:00
< th > Attributes< / th >
2018-09-03 16:05:28 +02:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2018-08-29 20:44:35 +02:00
2018-09-03 16:05:28 +02:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-29 20:44:35 +02:00
2018-09-03 16:05:28 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2018-09-03 16:05:28 +02:00
< / td >
2018-08-29 20:44:35 +02:00
2018-09-03 16:05:28 +02:00
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
2018-08-29 20:44:35 +02:00
2022-11-07 21:26:13 +01:00
< / td >
2018-09-03 16:05:28 +02:00
2018-08-29 20:44:35 +02:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > label name to filter< / td >
2018-09-03 16:05:28 +02:00
< / tr >
2018-08-29 20:44:35 +02:00
2018-09-03 16:05:28 +02:00
< / tbody >
< / table >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line640" > line 640< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
all note's label values, including inherited ones
2018-08-29 20:44:35 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Array.< string>< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2022-11-07 21:26:13 +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" > → {Array.< < a href = "Attribute.html" > Attribute< / a > >}< / span > < / h4 >
2021-11-10 21:30:54 +01:00
< h5 > Parameters:< / h5 >
2018-08-29 20:44:35 +02:00
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 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< td class = "attributes" >
< optional>< br >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< td class = "description last" > label name to filter< / td >
< / tr >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< / tbody >
< / table >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line632" > line 632< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
2021-11-10 21:30:54 +01:00
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
all note's labels (attributes with type label), including inherited ones
2021-11-10 21:30:54 +01:00
< / div >
2018-08-29 20:44:35 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Array.< < a href = "Attribute.html" > Attribute< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getOwnedAttribute" > < span class = "type-signature" > < / span > getOwnedAttribute< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "Attribute.html" > Attribute< / a > }< / span > < / h4 >
2018-11-08 23:49:44 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line707" > line 707< / a >
2018-11-08 23:49:44 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-11-08 23:49:44 +01:00
< h5 > Returns:< / h5 >
2020-09-30 22:48:30 +02:00
< div class = "param-desc" >
attribute belonging to this specific note (excludes inherited attributes)
This method can be significantly faster than the getAttribute()
< / div >
2018-11-08 23:49:44 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > < a href = "Attribute.html" > Attribute< / a > < / span >
2018-11-08 23:49:44 +01:00
< / dd >
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "getOwnedAttributeValue" > < span class = "type-signature" > < / span > getOwnedAttributeValue< span class = "signature" > (type, name)< / span > < span class = "type-signature" > → {string|null}< / span > < / h4 >
2019-09-07 22:03:08 +02:00
2020-09-30 22:48:30 +02:00
< h5 > Parameters:< / h5 >
2019-09-07 22:03:08 +02:00
2020-09-30 22:48:30 +02:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
2019-09-07 22:03:08 +02:00
2020-09-30 22:48:30 +02:00
< th > Type< / th >
2019-09-07 22:03:08 +02:00
2020-09-30 22:48:30 +02:00
2019-09-07 22:03:08 +02:00
2020-09-30 22:48:30 +02:00
2019-09-07 22:03:08 +02:00
2020-09-30 22:48:30 +02:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2019-09-07 22:03:08 +02:00
2020-09-30 22:48:30 +02:00
< tbody >
2019-09-07 22:03:08 +02:00
2020-09-30 22:48:30 +02:00
< tr >
< td class = "name" > < code > type< / code > < / td >
2019-09-07 22:03:08 +02:00
2020-09-30 22:48:30 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
2019-09-07 22:03:08 +02:00
2020-09-30 22:48:30 +02:00
< / td >
2019-12-03 22:53:17 +01:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > attribute type (label, relation, etc.)< / td >
2019-12-03 22:53:17 +01:00
< / tr >
2018-08-29 20:44:35 +02:00
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 >
2018-08-29 20:44:35 +02:00
2019-12-03 22:53:17 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2019-12-03 22:53:17 +01:00
2018-08-29 20:44:35 +02:00
2019-12-03 22:53:17 +01:00
2018-08-29 20:44:35 +02:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > attribute name< / td >
2022-06-19 14:06:00 +02:00
< / tr >
2019-12-03 22:53:17 +01:00
< / tbody >
< / table >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line622" > line 622< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
attribute value of given type and name or null if no such attribute exists.
2018-08-29 20:44:35 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > string< / span >
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2022-11-07 21:26:13 +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" > → {Array.< < a href = "Attribute.html" > Attribute< / a > >}< / span > < / h4 >
2019-12-03 22:53:17 +01:00
< h5 > Parameters:< / h5 >
2018-08-29 20:44:35 +02:00
2019-12-03 22:53:17 +01:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-11-07 21:26:13 +01:00
< th > Attributes< / th >
2019-12-03 22:53:17 +01:00
2022-12-14 23:51:56 +01:00
< th > Default< / th >
2019-12-03 22:53:17 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2018-08-29 20:44:35 +02:00
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 >
2022-12-14 23:51:56 +01:00
|
< span class = "param-type" > null< / span >
2019-12-03 22:53:17 +01:00
< / td >
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
2019-12-03 22:53:17 +01:00
2022-11-07 21:26:13 +01:00
< / td >
2019-12-03 22:53:17 +01:00
2022-11-07 21:26:13 +01:00
2022-12-14 23:51:56 +01:00
< td class = "default" >
null
< / td >
2022-11-07 21:26:13 +01:00
< td class = "description last" > (optional) attribute type to filter< / td >
2019-12-03 22:53:17 +01:00
< / tr >
2018-08-29 20:44:35 +02:00
2019-12-03 22:53:17 +01:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-29 20:44:35 +02:00
2019-12-03 22:53:17 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2022-12-14 23:51:56 +01:00
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
2019-12-03 22:53:17 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2019-12-03 22:53:17 +01:00
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
< / td >
2018-08-29 20:44:35 +02:00
2019-12-03 22:53:17 +01:00
2022-12-14 23:51:56 +01:00
< td class = "default" >
null
< / td >
2018-08-29 20:44:35 +02:00
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 >
2022-12-14 23:51:56 +01:00
|
< span class = "param-type" > null< / span >
2022-11-07 21:26:13 +01:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2022-12-14 23:51:56 +01:00
< td class = "default" >
null
< / td >
2022-11-07 21:26:13 +01:00
< td class = "description last" > (optional) attribute value to filter< / td >
2019-12-03 22:53:17 +01:00
< / tr >
2018-08-29 20:44:35 +02:00
2019-12-03 22:53:17 +01:00
< / tbody >
< / table >
2018-08-29 20:44:35 +02:00
2019-02-20 22:24:51 +01:00
< dl class = "details" >
2018-08-29 20:44:35 +02:00
2019-02-20 22:24:51 +01:00
2018-08-29 20:44:35 +02:00
2019-02-20 22:24:51 +01:00
2018-08-29 20:44:35 +02:00
2019-02-20 22:24:51 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line682" > line 682< / a >
2019-02-20 22:24:51 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2019-02-20 22:24:51 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
note's "owned" attributes - excluding inherited ones
2019-02-20 22:24:51 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Array.< < a href = "Attribute.html" > Attribute< / a > >< / span >
2019-02-20 22:24:51 +01:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getOwnedLabel" > < span class = "type-signature" > < / span > getOwnedLabel< span class = "signature" > (name)< / span > < span class = "type-signature" > → {< a href = "Attribute.html" > Attribute< / a > |null}< / span > < / h4 >
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" >
2018-08-29 20:44:35 +02:00
< span class = "param-type" > string< / span >
< / td >
2019-12-03 22:53:17 +01:00
< td class = "description last" > label name< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line547" > line 547< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2019-12-03 22:53:17 +01:00
label if it exists, null otherwise
2018-08-29 20:44:35 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > < a href = "Attribute.html" > Attribute< / a > < / span >
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
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" > → {string|null}< / span > < / h4 >
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 >
2022-11-07 21:26:13 +01:00
< td class = "description last" > label name< / td >
2018-11-13 12:50:08 +01:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line571" > line 571< / a >
2018-11-13 12:50:08 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-11-13 12:50:08 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
label value if label exists, null otherwise
2018-11-13 12:50:08 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > string< / span >
|
< span class = "param-type" > null< / span >
2018-11-13 12:50:08 +01:00
< / dd >
< / dl >
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" > → {Array.< string>}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2018-09-03 16:05:28 +02:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-11-07 21:26:13 +01:00
< th > Attributes< / th >
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 >
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
< / td >
2018-09-03 16:05:28 +02:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > label name to filter< / td >
2018-09-03 16:05:28 +02:00
< / tr >
< / tbody >
< / table >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line656" > line 656< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
all note's label values, excluding inherited ones
2018-08-29 20:44:35 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Array.< string>< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2022-11-07 21:26:13 +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" > → {Array.< < a href = "Attribute.html" > Attribute< / a > >}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2021-11-10 21:30:54 +01:00
< th > Attributes< / th >
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 >
2021-11-10 21:30:54 +01:00
< td class = "attributes" >
< optional>< br >
< / td >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< td class = "description last" > label name to filter< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line648" > line 648< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
all note's labels (attributes with type label), excluding inherited ones
2018-08-29 20:44:35 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Array.< < a href = "Attribute.html" > Attribute< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "getOwnedRelation" > < span class = "type-signature" > < / span > getOwnedRelation< span class = "signature" > (name)< / span > < span class = "type-signature" > → {< a href = "Attribute.html" > Attribute< / a > |null}< / span > < / h4 >
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 >
2021-11-10 21:30:54 +01:00
< td class = "description last" > relation name< / td >
2019-08-20 21:40:47 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line559" > line 559< / a >
2019-08-20 21:40:47 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
2019-12-03 22:53:17 +01:00
< div class = "param-desc" >
2021-11-10 21:30:54 +01:00
relation if it exists, null otherwise
2019-12-03 22:53:17 +01:00
< / div >
2019-08-20 21:40:47 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2021-11-10 21:30:54 +01:00
< span class = "param-type" > < a href = "Attribute.html" > Attribute< / a > < / span >
|
< span class = "param-type" > null< / span >
2019-08-20 21:40:47 +02:00
< / dd >
< / dl >
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" > → {string|null}< / span > < / h4 >
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 >
2022-11-07 21:26:13 +01:00
< td class = "description last" > relation name< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line583" > line 583< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
relation value if relation exists, null otherwise
2018-08-29 20:44:35 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > string< / span >
|
< span class = "param-type" > null< / span >
2019-12-03 22:53:17 +01:00
< / dd >
< / dl >
2022-11-07 21:26:13 +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" > → {Array.< < a href = "Attribute.html" > Attribute< / a > >}< / span > < / h4 >
2019-12-03 22:53:17 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-11-07 21:26:13 +01:00
< th > Attributes< / th >
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 >
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
< / td >
2019-12-03 22:53:17 +01:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > relation name to filter< / td >
2019-12-03 22:53:17 +01:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line672" > line 672< / a >
2019-12-03 22:53:17 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
all note's relations (attributes with type relation), excluding inherited ones
2019-12-03 22:53:17 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Array.< < a href = "Attribute.html" > Attribute< / a > >< / span >
2019-12-03 22:53:17 +01:00
< / dd >
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "getParentBranches" > < span class = "type-signature" > < / span > getParentBranches< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "Branch.html" > Branch< / a > >}< / span > < / h4 >
2019-12-03 22:53:17 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line155" > line 155< / a >
2019-12-03 22:53:17 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
2021-11-10 21:30:54 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Array.< < a href = "Branch.html" > Branch< / a > >< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getParentNotes" > < span class = "type-signature" > < / span > getParentNotes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "Note.html" > Note< / a > >}< / span > < / h4 >
2019-12-03 22:53:17 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line177" > line 177< / a >
2019-12-03 22:53:17 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > Array.< < a href = "Note.html" > Note< / a > >< / span >
2019-12-03 22:53:17 +01:00
< / dd >
< / dl >
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 >
2019-12-03 22:53:17 +01:00
< dl class = "details" >
2022-06-19 14:06:00 +02:00
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
< a href = "AbstractEntity.html#getPojoToSave" > AbstractEntity#getPojoToSave< / a >
< / li > < / ul > < / dd >
2019-12-03 22:53:17 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-06-19 14:06:00 +02:00
< a href = "becca_entities_abstract_entity.js.html" > becca/entities/abstract_entity.js< / a > , < a href = "becca_entities_abstract_entity.js.html#line71" > line 71< / a >
2019-12-03 22:53:17 +01:00
< / li > < / ul > < / dd >
< / dl >
2021-11-10 21:30:54 +01:00
2022-06-19 14:06:00 +02:00
2021-11-10 21:30:54 +01:00
2019-12-03 22:53:17 +01:00
2021-11-10 21:30:54 +01:00
2019-12-03 22:53:17 +01:00
2021-11-10 21:30:54 +01:00
2019-12-03 22:53:17 +01:00
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getRelation" > < span class = "type-signature" > < / span > getRelation< span class = "signature" > (name)< / span > < span class = "type-signature" > → {< a href = "Attribute.html" > Attribute< / a > |null}< / span > < / h4 >
2019-12-03 22:53:17 +01:00
2021-11-10 21:30:54 +01:00
2019-12-03 22:53:17 +01:00
< h5 > Parameters:< / h5 >
2021-11-10 21:30:54 +01:00
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 >
2021-11-10 21:30:54 +01:00
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 >
2021-11-10 21:30:54 +01:00
2019-12-03 22:53:17 +01:00
2021-11-10 21:30:54 +01:00
2019-12-03 22:53:17 +01:00
2021-11-10 21:30:54 +01:00
2019-12-03 22:53:17 +01:00
< td class = "description last" > relation name< / td >
< / tr >
2021-11-10 21:30:54 +01:00
2019-12-03 22:53:17 +01:00
< / tbody >
< / table >
2021-11-10 21:30:54 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line553" > line 553< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
2019-12-03 22:53:17 +01:00
< div class = "param-desc" >
relation if it exists, null otherwise
< / div >
2021-11-10 21:30:54 +01:00
2019-12-03 22:53:17 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > < a href = "Attribute.html" > Attribute< / a > < / span >
|
< span class = "param-type" > null< / span >
2019-12-03 22:53:17 +01:00
< / dd >
< / dl >
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" > → {string|null}< / span > < / h4 >
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 >
2022-11-07 21:26:13 +01:00
< td class = "description last" > relation name< / td >
2019-12-03 22:53:17 +01:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line577" > line 577< / a >
2019-12-03 22:53:17 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
relation value if relation exists, null otherwise
2019-12-03 22:53:17 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > string< / span >
|
< span class = "param-type" > null< / span >
2019-12-03 22:53:17 +01:00
< / dd >
< / dl >
2022-11-07 21:26:13 +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" > → {Array.< < a href = "Attribute.html" > Attribute< / a > >}< / span > < / h4 >
2019-12-03 22:53:17 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-11-07 21:26:13 +01:00
< th > Attributes< / th >
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 >
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
< / td >
2019-12-03 22:53:17 +01:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > relation name to filter< / td >
2019-12-03 22:53:17 +01:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line664" > line 664< / a >
2019-12-03 22:53:17 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
all note's relations (attributes with type relation), including inherited ones
2019-12-03 22:53:17 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Array.< < a href = "Attribute.html" > Attribute< / a > >< / span >
2019-12-03 22:53:17 +01:00
< / dd >
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "getScriptEnv" > < span class = "type-signature" > < / span > getScriptEnv< span class = "signature" > ()< / span > < span class = "type-signature" > → {string|null}< / span > < / h4 >
2019-12-03 22:53:17 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line353" > line 353< / a >
2019-12-03 22:53:17 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
2021-11-10 21:30:54 +01:00
< div class = "param-desc" >
JS script environment - either "frontend" or "backend"
< / div >
2019-12-03 22:53:17 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2021-11-10 21:30:54 +01:00
< span class = "param-type" > string< / span >
|
2019-12-03 22:53:17 +01:00
2021-11-10 21:30:54 +01:00
< span class = "param-type" > null< / span >
2019-12-03 22:53:17 +01:00
< / dd >
< / dl >
2022-11-12 20:40:40 +01:00
< h4 class = "name" id = "getSearchResultNotes" > < span class = "type-signature" > < / span > getSearchResultNotes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "Note.html" > Note< / a > >}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line867" > line 867< / a >
2022-11-12 20:40:40 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Array.< < a href = "Note.html" > Note< / a > >< / span >
< / dd >
< / dl >
2022-12-14 23:51:56 +01:00
< h4 class = "name" id = "getStrongParentBranches" > < span class = "type-signature" > < / span > getStrongParentBranches< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "Branch.html" > Branch< / a > >}< / span > < / h4 >
< div class = "description" >
Returns < i > strong< / i > (as opposed to < i > weak< / i > ) parent branches. See isWeak for details.
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line164" > line 164< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Array.< < a href = "Branch.html" > Branch< / a > >< / span >
< / dd >
< / dl >
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" > → {Object}< / span > < / h4 >
2019-12-03 22:53:17 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line890" > line 890< / a >
2019-12-03 22:53:17 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Object< / span >
2019-12-03 22:53:17 +01:00
< / dd >
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "getSubtreeNoteIds" > < span class = "type-signature" > < / span > getSubtreeNoteIds< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< String>}< / span > < / h4 >
2019-12-03 22:53:17 +01:00
2020-09-30 22:48:30 +02:00
2019-12-03 22:53:17 +01:00
2021-11-10 21:30:54 +01:00
2019-12-03 22:53:17 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line949" > line 949< / a >
2019-12-03 22:53:17 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Array.< String>< / span >
2019-12-03 22:53:17 +01:00
< / dd >
< / dl >
2022-06-19 14:06:00 +02:00
< h4 class = "name" id = "getSubtreeNotesIncludingTemplated" > < span class = "type-signature" > < / span > getSubtreeNotesIncludingTemplated< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "Note.html" > Note< / a > >}< / span > < / h4 >
2019-12-03 22:53:17 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line836" > line 836< / a >
2019-12-03 22:53:17 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2021-11-10 21:30:54 +01:00
< span class = "param-type" > Array.< < a href = "Note.html" > Note< / a > >< / span >
2019-12-03 22:53:17 +01:00
< / dd >
< / dl >
2022-06-19 14:06:00 +02:00
< h4 class = "name" id = "getTemplatedNotes" > < span class = "type-signature" > < / span > getTemplatedNotes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "Note.html" > Note< / a > >}< / span > < / h4 >
2019-12-03 22:53:17 +01:00
2020-09-30 22:48:30 +02:00
< dl class = "details" >
2019-12-03 22:53:17 +01:00
2020-09-30 22:48:30 +02:00
2019-12-03 22:53:17 +01:00
2020-09-30 22:48:30 +02:00
2019-12-03 22:53:17 +01:00
2020-09-30 22:48:30 +02:00
2019-12-03 22:53:17 +01:00
2020-09-30 22:48:30 +02:00
2019-12-03 22:53:17 +01:00
2020-09-30 22:48:30 +02:00
2019-12-03 22:53:17 +01:00
2020-09-30 22:48:30 +02:00
2019-12-03 22:53:17 +01:00
2020-09-30 22:48:30 +02:00
2019-12-03 22:53:17 +01:00
2020-09-30 22:48:30 +02:00
2019-12-03 22:53:17 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1054" > line 1054< / a >
2019-12-03 22:53:17 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
2022-06-19 14:06:00 +02:00
< div class = "param-desc" >
- returns only notes which are templated, does not include their subtrees
in effect returns notes which are influenced by note's non-inheritable attributes
< / div >
2019-12-03 22:53:17 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2021-11-10 21:30:54 +01:00
< span class = "param-type" > Array.< < a href = "Note.html" > Note< / a > >< / span >
2019-12-03 22:53:17 +01:00
< / dd >
< / dl >
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 >
2019-12-03 22:53:17 +01:00
< dl class = "details" >
2022-06-19 14:06:00 +02:00
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
< a href = "AbstractEntity.html#getUtcDateChanged" > AbstractEntity#getUtcDateChanged< / a >
< / li > < / ul > < / dd >
2019-12-03 22:53:17 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-06-19 14:06:00 +02:00
< a href = "becca_entities_abstract_entity.js.html" > becca/entities/abstract_entity.js< / a > , < a href = "becca_entities_abstract_entity.js.html#line45" > line 45< / a >
2019-12-03 22:53:17 +01:00
< / li > < / ul > < / dd >
< / dl >
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" > → {boolean}< / span > < / h4 >
2019-12-03 22:53:17 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1034" > line 1034< / a >
2019-12-03 22:53:17 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
2018-08-29 20:44:35 +02:00
2019-12-03 22:53:17 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2022-07-11 23:15:16 +02:00
< span class = "param-type" > boolean< / span >
2019-12-03 22:53:17 +01:00
< / dd >
< / dl >
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" > → {boolean}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
2022-12-14 23:51:56 +01:00
< th > Default< / th >
2022-07-11 23:15:16 +02:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2019-12-03 22:53:17 +01:00
2022-07-11 23:15:16 +02:00
< tr >
< td class = "name" > < code > type< / code > < / td >
< td class = "type" >
< / td >
< td class = "attributes" >
< / td >
2022-12-14 23:51:56 +01:00
< td class = "default" >
< / td >
2022-07-11 23:15:16 +02:00
< td class = "description last" > < / td >
< / tr >
2019-12-03 22:53:17 +01:00
2022-07-11 23:15:16 +02:00
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< / td >
< td class = "attributes" >
< / td >
2022-12-14 23:51:56 +01:00
< td class = "default" >
< / td >
2022-07-11 23:15:16 +02:00
< td class = "description last" > < / td >
< / tr >
2019-12-03 22:53:17 +01:00
2022-07-11 23:15:16 +02:00
< tr >
< td class = "name" > < code > value< / code > < / td >
2018-08-29 20:44:35 +02:00
2022-07-11 23:15:16 +02:00
< td class = "type" >
< / td >
2019-12-03 22:53:17 +01:00
2022-07-11 23:15:16 +02:00
< td class = "attributes" >
< optional>< br >
2019-12-03 22:53:17 +01:00
2022-07-11 23:15:16 +02:00
2018-08-29 20:44:35 +02:00
2022-07-11 23:15:16 +02:00
< / td >
2019-12-03 22:53:17 +01:00
2022-07-11 23:15:16 +02:00
2022-12-14 23:51:56 +01:00
< td class = "default" >
null
< / td >
2019-12-03 22:53:17 +01:00
2022-07-11 23:15:16 +02:00
< td class = "description last" > < / td >
< / tr >
2018-08-29 20:44:35 +02:00
2022-07-11 23:15:16 +02:00
< / tbody >
< / table >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line485" > line 485< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > boolean< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
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" > → {boolean}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line187" > line 187< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2019-12-03 22:53:17 +01:00
< span class = "param-type" > boolean< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
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" > → {boolean}< / span > < / h4 >
2018-11-08 23:49:44 +01:00
2019-12-03 22:53:17 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-06-19 14:06:00 +02:00
< th > Attributes< / th >
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 >
2022-06-19 14:06:00 +02:00
< td class = "attributes" >
< / td >
2019-12-03 22:53:17 +01:00
< td class = "description last" > label name< / td >
< / tr >
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" >
< optional>< br >
< / td >
< td class = "description last" > label value< / td >
< / tr >
2019-12-03 22:53:17 +01:00
< / tbody >
< / table >
2018-11-08 23:49:44 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line514" > line 514< / a >
2018-11-08 23:49:44 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-11-08 23:49:44 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2019-12-03 22:53:17 +01:00
true if label exists (including inherited)
2018-11-08 23:49:44 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > boolean< / span >
2018-11-08 23:49:44 +01:00
< / dd >
< / dl >
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" > → {boolean}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-06-19 14:06:00 +02:00
< th > Attributes< / th >
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 >
2022-06-19 14:06:00 +02:00
< td class = "attributes" >
< / td >
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 >
2022-06-19 14:06:00 +02:00
< td class = "attributes" >
< / td >
2018-08-29 20:44:35 +02:00
< td class = "description last" > attribute name< / td >
< / tr >
< tr >
2022-06-19 14:06:00 +02:00
< td class = "name" > < code > value< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2022-06-19 14:06:00 +02:00
< td class = "attributes" >
< optional>< br >
< / td >
2018-08-29 20:44:35 +02:00
2022-06-19 14:06:00 +02:00
< td class = "description last" > attribute value< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line591" > line 591< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2019-12-03 22:53:17 +01:00
true if note has an attribute with given type and name (excluding inherited)
2018-08-29 20:44:35 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > boolean< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
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" > → {boolean}< / span > < / h4 >
2018-09-03 16:05:28 +02:00
2019-12-03 22:53:17 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-06-19 14:06:00 +02:00
< th > Attributes< / th >
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 >
2022-06-19 14:06:00 +02:00
< td class = "attributes" >
< / td >
2019-12-03 22:53:17 +01:00
< td class = "description last" > label name< / td >
< / tr >
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" >
< optional>< br >
< / td >
< td class = "description last" > label value< / td >
< / tr >
2019-12-03 22:53:17 +01:00
< / tbody >
< / table >
2018-09-03 16:05:28 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line521" > line 521< / a >
2018-09-03 16:05:28 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-09-03 16:05:28 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2019-12-03 22:53:17 +01:00
true if label exists (excluding inherited)
2018-09-03 16:05:28 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > boolean< / span >
2018-09-03 16:05:28 +02:00
< / dd >
< / dl >
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" > → {boolean}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-06-19 14:06:00 +02:00
< th > Attributes< / th >
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 >
2022-06-19 14:06:00 +02:00
< td class = "attributes" >
< / td >
2018-08-29 20:44:35 +02:00
2019-12-03 22:53:17 +01:00
< td class = "description last" > relation name< / td >
2018-08-29 20:44:35 +02:00
< / tr >
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" >
< optional>< br >
< / td >
< td class = "description last" > relation value< / td >
< / tr >
2018-08-29 20:44:35 +02:00
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line535" > line 535< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2019-12-03 22:53:17 +01:00
true if relation exists (excluding inherited)
2018-08-29 20:44:35 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > boolean< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
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" > → {boolean}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-06-19 14:06:00 +02:00
< th > Attributes< / th >
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 >
2022-06-19 14:06:00 +02:00
< td class = "attributes" >
< / td >
2018-08-29 20:44:35 +02:00
< td class = "description last" > relation name< / td >
< / tr >
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" >
< optional>< br >
< / td >
< td class = "description last" > relation value< / td >
< / tr >
2018-08-29 20:44:35 +02:00
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-17 21:46:51 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line528" > line 528< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if relation exists (including inherited)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > boolean< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2019-11-27 23:07:10 +01:00
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" > → {boolean}< / span > < / h4 >
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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1113" > line 1113< / a >
2019-11-27 23:07:10 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
- true if ancestorNoteId occurs in at least one of the note's paths
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > boolean< / span >
2019-11-27 23:07:10 +01:00
< / dd >
< / dl >
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" > → {boolean}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line342" > line 342< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
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 >
< h4 class = "name" id = "isJavaScript" > < span class = "type-signature" > < / span > isJavaScript< span class = "signature" > ()< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line334" > line 334< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
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" > → {boolean}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line329" > line 329< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
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 >
< h4 class = "name" id = "isRoot" > < span class = "type-signature" > < / span > isRoot< span class = "signature" > ()< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line324" > line 324< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
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 >
2019-02-20 22:24:51 +01:00
< h4 class = "name" id = "isStringNote" > < span class = "type-signature" > < / span > isStringNote< span class = "signature" > ()< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-14 23:51:56 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line348" > line 348< / a >
2019-02-20 22:24:51 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2019-02-20 22:24:51 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if the note has string content (not binary)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
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.
2022-04-19 23:06:46 +02:00
This is a low level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
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" >
< 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 >
< a href = "AbstractEntity.html#markAsDeleted" > AbstractEntity#markAsDeleted< / a >
< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-06-19 14:06:00 +02:00
< a href = "becca_entities_abstract_entity.js.html" > becca/entities/abstract_entity.js< / a > , < a href = "becca_entities_abstract_entity.js.html#line125" > line 125< / a >
2022-04-16 00:17:32 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-02-20 22:24:51 +01:00
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 >
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" >
< optional>< br >
< / td >
< td class = "description last" > attribute value (optional)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1157" > line 1157< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
2020-09-30 22:48:30 +02:00
2018-08-29 20:44:35 +02:00
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 >
2018-08-29 20:44:35 +02:00
2020-09-30 22:48:30 +02:00
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" >
< optional>< br >
< / td >
< td class = "description last" > label value< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1272" > line 1272< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
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 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
Remove relation name-value pair, if it exists.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > relation name< / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > relation value (noteId)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1280" > line 1280< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
2022-04-16 00:17:32 +02:00
< h4 class = "name" id = "save" > < span class = "type-signature" > < / span > save< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "AbstractEntity.html" > AbstractEntity< / a > }< / 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 = "AbstractEntity.html#save" > AbstractEntity#save< / a >
< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-06-19 14:06:00 +02:00
< a href = "becca_entities_abstract_entity.js.html" > becca/entities/abstract_entity.js< / a > , < a href = "becca_entities_abstract_entity.js.html#line80" > line 80< / a >
2022-04-16 00:17:32 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "AbstractEntity.html" > AbstractEntity< / a > < / span >
< / dd >
< / dl >
2018-08-29 20:44:35 +02:00
2022-06-02 17:25:58 +02:00
< h4 class = "name" id = "saveNoteRevision" > < span class = "type-signature" > < / span > saveNoteRevision< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "NoteRevision.html" > NoteRevision< / a > |null}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1362" > line 1362< / a >
2022-06-02 17:25:58 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "NoteRevision.html" > NoteRevision< / a > < / span >
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
2020-09-30 22:48:30 +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 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2019-11-08 22:34:30 +01:00
Update's given attribute's value or creates it if it doesn't exist
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 (label, relation, etc.)< / td >
< / tr >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > attribute name< / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > attribute value (optional)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1126" > line 1126< / a >
2019-02-20 22:24:51 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2019-02-20 22:24:51 +01:00
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 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2019-11-08 22:34:30 +01:00
Update's given label's value or creates it if it doesn't exist
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" >
< optional>< br >
< / td >
< td class = "description last" > label value< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1256" > line 1256< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
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 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2019-11-08 22:34:30 +01:00
Update's given relation's value or creates it if it doesn't exist
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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1264" > line 1264< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
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 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
Based on enabled, attribute is either set or removed.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > attribute type ('relation', 'label' etc.)< / td >
< / tr >
< tr >
< td class = "name" > < code > enabled< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > toggle On or Off< / td >
< / tr >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > attribute name< / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > attribute value (optional)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1223" > line 1223< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
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 >
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" >
< optional>< br >
< / td >
< td class = "description last" > label value (optional)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1239" > line 1239< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
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 >
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" >
< optional>< br >
< / td >
< td class = "description last" > relation value (noteId)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-12-25 13:01:50 +01:00
< a href = "becca_entities_note.js.html" > becca/entities/note.js< / a > , < a href = "becca_entities_note.js.html#line1248" > line 1248< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< / article >
< / section >
< / div >
< nav >
2022-12-25 13:01:50 +01: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 = "AbstractEntity.html" > AbstractEntity< / 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 = "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 > Global< / h3 > < ul > < li > < a href = "global.html#SortConfig" > SortConfig< / a > < / li > < / ul >
2018-08-29 20:44:35 +02:00
< / nav >
< br class = "clear" >
< footer >
2022-11-07 21:26:13 +01:00
Documentation generated by < a href = "https://github.com/jsdoc/jsdoc" > JSDoc 4.0.0< / a >
2018-08-29 20:44:35 +02:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
