2018-08-29 20:44:35 +02:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > JSDoc: Class: NoteShort< / title >
< script src = "scripts/prettify/prettify.js" > < / script >
< script src = "scripts/prettify/lang-css.js" > < / script >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/prettify-tomorrow.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/jsdoc-default.css" >
< / head >
< body >
< div id = "main" >
< h1 class = "page-title" > Class: NoteShort< / h1 >
< section >
< header >
< h2 > < span class = "attribs" > < span class = "type-signature" > < / span > < / span > NoteShort< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h2 >
< div class = "class-description" > This note's representation is used in note tree and is kept in TreeCache.
Its notable omission is the note content.< / div >
< / header >
< article >
< div class = "container-overview" >
< h2 > Constructor< / h2 >
< h4 class = "name" id = "NoteShort" > < span class = "type-signature" > < / span > new NoteShort< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line14" > line 14< / 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
< / div >
< h3 class = "subsection-title" > Members< / h3 >
< h4 class = "name" id = "archived" > < span class = "type-signature" > < / span > archived< span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line27" > line 27< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "isProtected" > < span class = "type-signature" > < / span > isProtected< span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line21" > line 21< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "mime" > < span class = "type-signature" > < / span > mime< span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line25" > line 25< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "noteId" > < span class = "type-signature" > < / span > noteId< span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line17" > line 17< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "title" > < span class = "type-signature" > < / span > title< span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line19" > line 19< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "type" > < span class = "type-signature" > < / span > type< span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line23" > line 23< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
2018-12-22 22:28:49 +01:00
< h4 class = "name" id = "getAttribute" > < span class = "type-signature" > (async) < / span > getAttribute< span class = "signature" > (type, name)< / span > < span class = "type-signature" > → {Promise.< < a href = "Attribute.html" > Attribute< / a > >}< / span > < / h4 >
< h5 > Parameters:< / h5 >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< tr >
< td class = "name" > < code > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > attribute type (label, relation, etc.)< / td >
< / tr >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< / td >
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
< td class = "description last" > attribute name< / td >
< / tr >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +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 >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line146" > line 146< / 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" >
attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
< / div >
2018-08-29 20:44:35 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2018-12-22 22:28:49 +01:00
< span class = "param-type" > Promise.< < a href = "Attribute.html" > Attribute< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2018-12-22 22:28:49 +01:00
< h4 class = "name" id = "getAttributes" > < span class = "type-signature" > (async) < / span > getAttributes< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>}< / span > < / h4 >
< h5 > Parameters:< / h5 >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +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
2018-12-22 22:28:49 +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
2018-12-22 22:28:49 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< td class = "attributes" >
< optional>< br >
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
< / td >
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
< td class = "description last" > attribute name to filter< / td >
< / tr >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +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 >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line86" > line 86< / 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 >
2018-12-22 22:28:49 +01:00
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2018-12-22 22:28:49 +01:00
< h4 class = "name" id = "getAttributeValue" > < span class = "type-signature" > (async) < / span > getAttributeValue< span class = "signature" > (type, name)< / span > < span class = "type-signature" > → {Promise.< string>}< / span > < / h4 >
< h5 > Parameters:< / h5 >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< tr >
< td class = "name" > < code > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > attribute type (label, relation, etc.)< / td >
< / tr >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< / td >
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
< td class = "description last" > attribute name< / td >
< / tr >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +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 >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line157" > line 157< / 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" >
attribute value of given type and name or null if no such attribute exists.
< / div >
2018-08-29 20:44:35 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2018-12-22 22:28:49 +01:00
< span class = "param-type" > Promise.< string>< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2018-12-22 22:28:49 +01:00
< h4 class = "name" id = "getBranches" > < span class = "type-signature" > (async) < / span > getBranches< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Branch.html" > Branch< / 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 >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line37" > line 37< / 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 >
2018-12-22 22:28:49 +01:00
< span class = "param-type" > Promise.< Array.< < a href = "Branch.html" > Branch< / a > >>< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2018-12-22 22:28:49 +01:00
< h4 class = "name" id = "getChildBranches" > < span class = "type-signature" > (async) < / span > getChildBranches< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Branch.html" > Branch< / 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 >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line51" > line 51< / 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 >
2018-12-22 22:28:49 +01:00
< span class = "param-type" > Promise.< Array.< < a href = "Branch.html" > Branch< / a > >>< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2018-12-22 22:28:49 +01:00
< h4 class = "name" id = "getChildNoteIds" > < span class = "type-signature" > < / span > getChildNoteIds< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< string>}< / 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 >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line73" > line 73< / 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 >
2018-12-22 22:28:49 +01:00
< span class = "param-type" > Array.< string>< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2018-12-22 22:28:49 +01:00
< h4 class = "name" id = "getChildNotes" > < span class = "type-signature" > (async) < / span > getChildNotes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "NoteShort.html" > NoteShort< / 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 >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line78" > line 78< / 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 >
2018-12-22 22:28:49 +01:00
< span class = "param-type" > Promise.< Array.< < a href = "NoteShort.html" > NoteShort< / a > >>< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2018-12-22 22:28:49 +01:00
< h4 class = "name" id = "getLabel" > < span class = "type-signature" > (async) < / span > getLabel< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< < a href = "Attribute.html" > Attribute< / a > >}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Parameters:< / h5 >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< / td >
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
< td class = "description last" > label name< / td >
< / tr >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +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 >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line179" > line 179< / 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 >
< div class = "param-desc" >
label if it exists, null otherwise
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< < a href = "Attribute.html" > Attribute< / a > >< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getLabelDefinitions" > < span class = "type-signature" > (async) < / span > getLabelDefinitions< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > label name to filter< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line112" > line 112< / 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 >
< div class = "param-desc" >
all note's label definitions, including inherited ones
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getLabels" > < span class = "type-signature" > (async) < / span > getLabels< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > label name to filter< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line104" > line 104< / 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 >
< div class = "param-desc" >
all note's labels (attributes with type label), including inherited ones
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getLabelValue" > < span class = "type-signature" > (async) < / span > getLabelValue< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< string>}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > label name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line191" > line 191< / 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 >
< div class = "param-desc" >
label value if label exists, null otherwise
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< string>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getParentNoteIds" > < span class = "type-signature" > < / span > getParentNoteIds< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< string>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line63" > line 63< / 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 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Array.< string>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getParentNotes" > < span class = "type-signature" > (async) < / span > getParentNotes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "NoteShort.html" > NoteShort< / a > >>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line68" > line 68< / 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 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "NoteShort.html" > NoteShort< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getRelation" > < span class = "type-signature" > (async) < / span > getRelation< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< < a href = "Attribute.html" > Attribute< / a > >}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > relation name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line185" > line 185< / 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 >
< div class = "param-desc" >
relation if it exists, null otherwise
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< < a href = "Attribute.html" > Attribute< / a > >< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getRelationDefinitions" > < span class = "type-signature" > (async) < / span > getRelationDefinitions< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > relation name to filter< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line128" > line 128< / 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 >
< div class = "param-desc" >
all note's relation definitions including inherited ones
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getRelations" > < span class = "type-signature" > (async) < / span > getRelations< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > relation name to filter< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line120" > line 120< / 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 >
< div class = "param-desc" >
all note's relations (attributes with type relation), including inherited ones
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
< / dd >
< / dl >
2019-08-20 21:40:47 +02:00
< h4 class = "name" id = "getRelationTarget" > < span class = "type-signature" > (async) < / span > getRelationTarget< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< < a href = "NoteShort.html" > NoteShort< / a > >|null}< / span > < / h4 >
2018-12-22 22:28:49 +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 >
< 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 >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line203" > line 203< / 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 >
< div class = "param-desc" >
target note of the relation or null (if target is empty or note was not found)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2019-08-20 21:40:47 +02:00
< span class = "param-type" > Promise.< < a href = "NoteShort.html" > NoteShort< / a > >< / span >
2018-12-22 22:28:49 +01:00
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
2019-08-20 21:40:47 +02:00
< h4 class = "name" id = "getRelationTargets" > < span class = "type-signature" > (async) < / span > getRelationTargets< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "NoteShort.html" > NoteShort< / a > >>}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > relation name to filter< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line213" > line 213< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "NoteShort.html" > NoteShort< / a > >>< / span >
< / dd >
< / dl >
2018-12-22 22:28:49 +01:00
< h4 class = "name" id = "getRelationValue" > < span class = "type-signature" > (async) < / span > getRelationValue< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< string>}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > relation name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line197" > line 197< / 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 >
< div class = "param-desc" >
relation value if relation exists, null otherwise
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< string>< / span >
< / dd >
< / dl >
2019-08-20 21:40:47 +02:00
< h4 class = "name" id = "getTargetRelations" > < span class = "type-signature" > (async) < / span > getTargetRelations< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>}< / span > < / h4 >
< div class = "description" >
Get relations which target this note
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line237" > line 237< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
< / dd >
< / dl >
2018-12-22 22:28:49 +01:00
< h4 class = "name" id = "hasAttribute" > < span class = "type-signature" > (async) < / span > hasAttribute< span class = "signature" > (type, name)< / span > < span class = "type-signature" > → {Promise.< boolean>}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > attribute type (label, relation, etc.)< / td >
< / tr >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > attribute name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line137" > line 137< / a >
2018-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 >
< div class = "param-desc" >
true if note has an attribute with given type and name (including inherited)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< boolean>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "hasChildren" > < span class = "type-signature" > < / span > hasChildren< 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 >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line45" > line 45< / 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 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< h4 class = "name" id = "hasLabel" > < span class = "type-signature" > (async) < / span > hasLabel< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< boolean>}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > label name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line167" > line 167< / 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 >
< div class = "param-desc" >
true if label exists (including inherited)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< boolean>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "hasRelation" > < span class = "type-signature" > (async) < / span > hasRelation< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< boolean>}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > relation name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line173" > line 173< / 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 >
< div class = "param-desc" >
true if relation exists (including inherited)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< boolean>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "invalidateAttributeCache" > < span class = "type-signature" > < / span > invalidateAttributeCache< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< div class = "description" >
Clear note's attributes cache to force fresh reload for next attribute request.
Cache is note instance scoped.
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line228" > line 228< / a >
2018-12-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
< 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 >
2019-08-20 21:40:47 +02:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line32" > line 32< / 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 >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / article >
< / section >
< / div >
< nav >
< h2 > < a href = "index.html" > Home< / a > < / h2 > < h3 > Classes< / h3 > < ul > < li > < a href = "Branch.html" > Branch< / a > < / li > < li > < a href = "FrontendScriptApi.html" > FrontendScriptApi< / a > < / li > < li > < a href = "NoteFull.html" > NoteFull< / a > < / li > < li > < a href = "NoteShort.html" > NoteShort< / a > < / li > < / ul > < h3 > < a href = "global.html" > Global< / a > < / h3 >
< / nav >
< br class = "clear" >
< footer >
2019-08-20 21:40:47 +02:00
Documentation generated by < a href = "https://github.com/jsdoc/jsdoc" > JSDoc 3.6.3< / a >
2018-08-29 20:44:35 +02:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
