2018-08-30 02:44:35 +08: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 >
2019-10-07 03:35:26 +08:00
< div class = "class-description" > FIXME: rethink how attributes are cached in Note entities since they are long lived inside the cache.
Attribute cache should be limited to "transaction".
This note's representation is used in note tree and is kept in TreeCache.< / div >
2018-08-30 02:44:35 +08:00
< / 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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line16" > line 16< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-08-30 02:44:35 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line29" > line 29< / a >
2019-09-08 04:03:08 +08:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "cssClass" > < span class = "type-signature" > < / span > cssClass< span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line31" > line 31< / a >
2018-08-30 02:44:35 +08: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-10-07 03:35:26 +08: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-30 02:44:35 +08: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-10-07 03:35:26 +08: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-30 02:44:35 +08: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-10-07 03:35:26 +08: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-30 02:44:35 +08: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-10-07 03:35:26 +08: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-30 02:44:35 +08: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-10-07 03:35:26 +08: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-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
2018-12-23 05:28:49 +08: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-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08: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-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< / td >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< td class = "description last" > attribute name< / td >
< / tr >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< / tbody >
< / table >
2018-08-30 02:44:35 +08:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line169" > line 169< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-08-30 02:44:35 +08:00
< h5 > Returns:< / h5 >
2018-12-23 05:28:49 +08: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-30 02:44:35 +08:00
< dl >
< dt >
Type
< / dt >
< dd >
2018-12-23 05:28:49 +08:00
< span class = "param-type" > Promise.< < a href = "Attribute.html" > Attribute< / a > >< / span >
2018-08-30 02:44:35 +08:00
< / dd >
< / dl >
2018-12-23 05:28:49 +08: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-30 02:44:35 +08:00
2018-12-23 05:28:49 +08: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-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< / td >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< td class = "attributes" >
< optional>< br >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< / td >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< td class = "description last" > attribute name to filter< / td >
< / tr >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< / tbody >
< / table >
2018-08-30 02:44:35 +08:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line109" > line 109< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-08-30 02:44:35 +08:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2018-12-23 05:28:49 +08:00
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
2018-08-30 02:44:35 +08:00
< / dd >
< / dl >
2018-12-23 05:28:49 +08: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-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08: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-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< / td >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< td class = "description last" > attribute name< / td >
< / tr >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< / tbody >
< / table >
2018-08-30 02:44:35 +08:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line180" > line 180< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-08-30 02:44:35 +08:00
< h5 > Returns:< / h5 >
2018-12-23 05:28:49 +08:00
< div class = "param-desc" >
attribute value of given type and name or null if no such attribute exists.
< / div >
2018-08-30 02:44:35 +08:00
< dl >
< dt >
Type
< / dt >
< dd >
2018-12-23 05:28:49 +08:00
< span class = "param-type" > Promise.< string>< / span >
2018-08-30 02:44:35 +08:00
< / dd >
< / dl >
2018-12-23 05:28:49 +08: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-30 02:44:35 +08:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line60" > line 60< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-08-30 02:44:35 +08:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2018-12-23 05:28:49 +08:00
< span class = "param-type" > Promise.< Array.< < a href = "Branch.html" > Branch< / a > >>< / span >
2018-08-30 02:44:35 +08:00
< / dd >
< / dl >
2018-12-23 05:28:49 +08: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-30 02:44:35 +08:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line74" > line 74< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-08-30 02:44:35 +08:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2018-12-23 05:28:49 +08:00
< span class = "param-type" > Promise.< Array.< < a href = "Branch.html" > Branch< / a > >>< / span >
2018-08-30 02:44:35 +08:00
< / dd >
< / dl >
2018-12-23 05:28:49 +08: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-30 02:44:35 +08:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line96" > line 96< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-08-30 02:44:35 +08:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2018-12-23 05:28:49 +08:00
< span class = "param-type" > Array.< string>< / span >
2018-08-30 02:44:35 +08:00
< / dd >
< / dl >
2018-12-23 05:28:49 +08: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-30 02:44:35 +08:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line101" > line 101< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-08-30 02:44:35 +08:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2018-12-23 05:28:49 +08:00
< span class = "param-type" > Promise.< Array.< < a href = "NoteShort.html" > NoteShort< / a > >>< / span >
2018-08-30 02:44:35 +08:00
< / dd >
< / dl >
2018-12-23 05:28:49 +08: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-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< h5 > Parameters:< / h5 >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< / td >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< td class = "description last" > label name< / td >
< / tr >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< / tbody >
< / table >
2018-08-30 02:44:35 +08:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line202" > line 202< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line135" > line 135< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line127" > line 127< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line214" > line 214< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-10-07 03:35:26 +08: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-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line91" > line 91< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line208" > line 208< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line151" > line 151< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line143" > line 143< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-21 03:40:47 +08: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-23 05:28:49 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line226" > line 226< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-21 03:40:47 +08:00
< span class = "param-type" > Promise.< < a href = "NoteShort.html" > NoteShort< / a > >< / span >
2018-12-23 05:28:49 +08:00
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
2019-08-21 03:40:47 +08: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 >
2019-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line236" > line 236< / a >
2019-08-21 03:40:47 +08:00
< / 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-23 05:28:49 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line220" > line 220< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-21 03:40:47 +08: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 >
2019-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line260" > line 260< / a >
2019-08-21 03:40:47 +08:00
< / 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-23 05:28:49 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line160" > line 160< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-10-07 03:35:26 +08: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-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line190" > line 190< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line196" > line 196< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line251" > line 251< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08: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-10-07 03:35:26 +08:00
< a href = "entities_note_short.js.html" > entities/note_short.js< / a > , < a href = "entities_note_short.js.html#line35" > line 35< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-08-30 02:44:35 +08: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-21 03:40:47 +08:00
Documentation generated by < a href = "https://github.com/jsdoc/jsdoc" > JSDoc 3.6.3< / a >
2018-08-30 02:44:35 +08:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
