2018-08-30 02:44:35 +08: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 >
< h2 > < span class = "attribs" > < span class = "type-signature" > < / span > < / span > Note< span class = "signature" > (row)< / span > < span class = "type-signature" > < / span > < / h2 >
< div class = "class-description" > This represents a Note which is a central object in the Trilium Notes project.< / div >
< / header >
< article >
< div class = "container-overview" >
< h2 > Constructor< / h2 >
< h4 class = "name" id = "Note" > < span class = "type-signature" > < / span > new Note< span class = "signature" > (row)< / span > < span class = "type-signature" > < / 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 > row< / code > < / td >
< td class = "type" >
< / td >
< td class = "description last" > object containing database row from "notes" table< / td >
< / tr >
< / tbody >
< / table >
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > noteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > primary key< / td >
< / tr >
< tr >
< td class = "name" > < code > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > one of "text", "code", "file" or "render"< / td >
< / tr >
< tr >
< td class = "name" > < code > mime< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > MIME type, e.g. "text/html"< / td >
< / tr >
< tr >
< td class = "name" > < code > title< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > note title< / td >
< / tr >
2019-11-19 06:01:31 +08:00
< tr >
< td class = "name" > < code > contentLength< / code > < / td >
< td class = "type" >
< span class = "param-type" > int< / span >
< / td >
< td class = "description last" > length of content< / td >
< / tr >
2018-08-30 02:44:35 +08:00
< tr >
< td class = "name" > < code > isProtected< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > true if note is protected< / td >
< / tr >
< tr >
< td class = "name" > < code > isDeleted< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > true if note is deleted< / td >
< / tr >
2019-11-09 05:34:30 +08:00
< tr >
< td class = "name" > < code > isErased< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > true if note's content is erased after it has been deleted< / td >
< / tr >
2018-08-30 02:44:35 +08:00
< tr >
< td class = "name" > < code > dateCreated< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2019-03-15 03:49:10 +08:00
< td class = "description last" > local date time (with offset)< / td >
2018-08-30 02:44:35 +08:00
< / tr >
< tr >
< td class = "name" > < code > dateModified< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2019-03-15 03:49:10 +08:00
< td class = "description last" > local date time (with offset)< / td >
< / tr >
< tr >
< td class = "name" > < code > utcDateCreated< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > utcDateModified< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2018-08-30 02:44:35 +08:00
< 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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line43" > line 43< / 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" > Extends< / h3 >
< ul >
< li > < a href = "Entity.html" > Entity< / a > < / li >
< / ul >
< h3 class = "subsection-title" > Methods< / h3 >
2019-11-19 06:01:31 +08:00
< h4 class = "name" id = "addAttribute" > < span class = "type-signature" > (async) < / span > addAttribute< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< < a href = "Attribute.html" > Attribute< / a > >}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line482" > line 482< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< < a href = "Attribute.html" > Attribute< / a > >< / span >
< / dd >
< / dl >
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 >
2018-08-30 02:44:35 +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 > 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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line389" > line 389< / 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 >
2018-08-30 02:44:35 +08:00
< 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 >
2018-12-23 05:28:49 +08:00
< td class = "description last" > attribute name to filter< / td >
2018-08-30 02:44:35 +08:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line243" > line 243< / 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" >
all note's attributes, including inherited ones
< / 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.< 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 >
2018-08-30 02:44:35 +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 >
2018-12-23 05:28:49 +08:00
< td class = "name" > < code > type< / code > < / td >
2018-08-30 02:44:35 +08:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2018-12-23 05:28:49 +08:00
< td class = "description last" > attribute type (label, relation, etc.)< / td >
2018-08-30 02:44:35 +08:00
< / tr >
< tr >
2018-12-23 05:28:49 +08:00
< td class = "name" > < code > name< / code > < / td >
2018-08-30 02:44:35 +08:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2018-12-23 05:28:49 +08:00
< td class = "description last" > attribute name< / td >
2018-08-30 02:44:35 +08:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line400" > line 400< / 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
2018-12-23 05:28:49 +08:00
< dl class = "details" >
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
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line710" > line 710< / 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 >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< dl >
< dt >
Type
< / dt >
< dd >
2018-08-30 02:44:35 +08:00
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
2018-12-23 05:28:49 +08:00
< / dd >
< / dl >
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
< 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
2018-12-23 05:28:49 +08:00
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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line738" > line 738< / 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 >
< div class = "param-desc" >
2018-12-23 05:28:49 +08:00
child branches of this note
2018-08-30 02:44:35 +08:00
< / div >
< 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 = "getChildNotes" > < span class = "type-signature" > (async) < / span > getChildNotes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Note.html" > Note< / a > >>}< / span > < / h4 >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< dl class = "details" >
2018-09-03 22:05:28 +08:00
2018-12-23 05:28:49 +08:00
2018-09-03 22:05:28 +08:00
2018-12-23 05:28:49 +08:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line724" > line 724< / 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 >
2018-09-03 22:05:28 +08:00
2018-12-23 05:28:49 +08:00
< div class = "param-desc" >
child notes of this note
< / div >
2018-09-03 22:05:28 +08:00
2018-12-23 05:28:49 +08:00
< dl >
< dt >
Type
< / dt >
< dd >
2018-09-03 22:05:28 +08:00
2018-12-23 05:28:49 +08:00
< span class = "param-type" > Promise.< Array.< < a href = "Note.html" > Note< / a > >>< / span >
2018-09-03 22:05:28 +08:00
2018-12-23 05:28:49 +08:00
< / dd >
< / dl >
2018-09-03 22:05:28 +08:00
2018-12-23 05:28:49 +08:00
2018-09-03 22:05:28 +08:00
2018-12-23 05:28:49 +08:00
2019-02-21 05:24:51 +08:00
< h4 class = "name" id = "getContent" > < span class = "type-signature" > (async) < / span > getContent< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< *>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line74" > line 74< / a >
2019-02-21 05:24:51 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2019-02-21 05:24:51 +08:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< *>< / span >
< / dd >
< / dl >
2018-12-23 05:28:49 +08:00
< h4 class = "name" id = "getDescendantNoteIds" > < span class = "type-signature" > (async) < / span > getDescendantNoteIds< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< string>>}< / span > < / h4 >
2018-09-03 22:05:28 +08:00
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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line610" > line 610< / 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 >
< div class = "param-desc" >
2018-12-23 05:28:49 +08:00
return list of all descendant noteIds of this note. Returning just noteIds because number of notes can be huge. Includes also this note's noteId
2018-08-30 02:44:35 +08:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2018-12-23 05:28:49 +08:00
< span class = "param-type" > Promise.< 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 = "getDescendantNotesWithAttribute" > < span class = "type-signature" > (async) < / span > getDescendantNotesWithAttribute< span class = "signature" > (type, name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Note.html" > Note< / a > >>}< / span > < / h4 >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< div class = "description" >
Finds descendant notes with given attribute name and value. Only own attributes are considered, not inherited ones
< / div >
2018-08-30 02:44:35 +08:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2018-12-23 05:28:49 +08:00
< th > Attributes< / th >
2018-08-30 02:44:35 +08: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 >
2018-12-23 05:28:49 +08:00
< td class = "attributes" >
< / td >
2018-08-30 02:44:35 +08: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 >
2018-12-23 05:28:49 +08:00
< 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 >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< td class = "description last" > attribute value< / td >
2018-08-30 02:44:35 +08:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line633" > line 633< / 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 = "Note.html" > Note< / a > >>< / span >
2018-08-30 02:44:35 +08:00
< / dd >
< / dl >
2018-12-23 05:28:49 +08:00
< h4 class = "name" id = "getDescendantNotesWithLabel" > < span class = "type-signature" > (async) < / span > getDescendantNotesWithLabel< span class = "signature" > (name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Note.html" > Note< / a > >>}< / span > < / h4 >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< div class = "description" >
Finds descendant notes with given label name and value. Only own labels are considered, not inherited ones
< / div >
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 >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< th > Type< / th >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< th > Attributes< / th >
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
< th class = "last" > Description< / th >
< / tr >
< / thead >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< 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
< td class = "attributes" >
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" > label name< / td >
< / tr >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< tr >
< td class = "name" > < code > value< / 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
< 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" > label value< / 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
2018-12-23 05:28:49 +08:00
< dl class = "details" >
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
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
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
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
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line671" > line 671< / a >
2018-12-23 05:28:49 +08:00
< / li > < / ul > < / dd >
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
< / dl >
2018-08-30 02:44:35 +08:00
2019-08-21 03:40:47 +08:00
2018-12-23 05:28:49 +08:00
< h5 > Returns:< / h5 >
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
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Note.html" > Note< / a > >>< / span >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< / dd >
< / dl >
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
< h4 class = "name" id = "getDescendantNotesWithRelation" > < span class = "type-signature" > (async) < / span > getDescendantNotesWithRelation< span class = "signature" > (name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Note.html" > Note< / a > >>}< / span > < / h4 >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< div class = "description" >
Finds descendant notes with given relation name and value. Only own relations are considered, not inherited ones
< / div >
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 >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< th > Type< / th >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< th > Attributes< / th >
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
< th class = "last" > Description< / th >
< / tr >
< / thead >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< 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
< td class = "attributes" >
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
< td class = "description last" > relation name< / td >
< / tr >
2018-08-30 02:44:35 +08:00
2018-12-23 05:28:49 +08:00
< tr >
< td class = "name" > < code > value< / 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
< 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" > relation value< / 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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line680" > line 680< / 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" > Promise.< Array.< < a href = "Note.html" > Note< / a > >>< / span >
< / dd >
< / dl >
2019-02-21 05:24:51 +08:00
< h4 class = "name" id = "getJsonContent" > < span class = "type-signature" > (async) < / span > getJsonContent< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< *>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line109" > line 109< / a >
2019-02-21 05:24:51 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2019-02-21 05:24:51 +08:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< *>< / span >
< / dd >
< / dl >
2018-08-30 02:44:35 +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 >
< 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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line521" > line 521< / 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 >
< 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 >
2018-11-13 19:50:08 +08:00
< 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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line268" > line 268< / a >
2018-11-13 19:50:08 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-11-13 19:50:08 +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 >
2018-09-03 22:05:28 +08:00
< 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 >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +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-09-03 22:05:28 +08:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
< / td >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
< td class = "attributes" >
< optional>< br >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
< / td >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
< td class = "description last" > label name to filter< / td >
< / tr >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line260" > line 260< / 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 >
< 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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line533" > line 533< / 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 >
< 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 >
2019-08-21 03:40:47 +08:00
< h4 class = "name" id = "getLinks" > < span class = "type-signature" > (async) < / span > getLinks< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>}< / span > < / h4 >
2018-11-09 06:49:44 +08:00
2018-11-15 20:58:14 +08:00
< div class = "description" >
Get list of links coming out of this note.
< / div >
2018-11-09 06:49:44 +08:00
< dl class = "details" >
2019-08-21 03:40:47 +08:00
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > - not intended for general use< / li > < / ul > < / dd >
2018-11-09 06:49:44 +08:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line697" > line 697< / a >
2018-11-09 06:49:44 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-11-09 06:49:44 +08:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2019-08-21 03:40:47 +08:00
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
2018-11-09 06:49:44 +08:00
< / dd >
< / dl >
2019-09-08 04:03:08 +08:00
< h4 class = "name" id = "getOwnedAttribute" > < span class = "type-signature" > (async) < / span > getOwnedAttribute< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< < a href = "Attribute.html" > Attribute< / a > >}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line226" > line 226< / a >
2019-09-08 04:03:08 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
attribute belonging to this specific note (excludes inherited attributes)
This method can be significantly faster than the getAttribute()
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< < a href = "Attribute.html" > Attribute< / a > >< / span >
< / dd >
< / dl >
2019-02-21 05:24:51 +08:00
< h4 class = "name" id = "getOwnedAttributes" > < span class = "type-signature" > (async) < / span > getOwnedAttributes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / 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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line204" > line 204< / 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 >
< div class = "param-desc" >
2019-02-21 05:24:51 +08:00
attributes belonging to this specific note (excludes inherited attributes)
2019-09-08 04:03:08 +08:00
This method can be significantly faster than the getAttributes()
2018-08-30 02:44:35 +08:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2019-02-21 05:24:51 +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 >
2019-02-21 05:24:51 +08:00
< h4 class = "name" id = "getParentNotes" > < span class = "type-signature" > (async) < / span > getParentNotes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Note.html" > Note< / a > >>}< / span > < / h4 >
2018-08-30 02:44:35 +08:00
2019-02-21 05:24:51 +08:00
< dl class = "details" >
2018-08-30 02:44:35 +08:00
2019-02-21 05:24:51 +08:00
2018-08-30 02:44:35 +08:00
2019-02-21 05:24:51 +08:00
2018-08-30 02:44:35 +08:00
2019-02-21 05:24:51 +08:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line750" > line 750< / a >
2019-02-21 05:24:51 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2019-02-21 05:24:51 +08:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
parent notes of this note (note can have multiple parents because of cloning)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Note.html" > Note< / 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" >
2018-08-30 02:44:35 +08:00
< 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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line527" > line 527< / 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 >
< 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 >
2018-11-13 19:50:08 +08:00
< 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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line299" > line 299< / a >
2018-11-13 19:50:08 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-11-13 19:50:08 +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 >
2018-09-03 22:05:28 +08:00
< 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 >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
< 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 >
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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line276" > line 276< / 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 >
< 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 >
< h4 class = "name" id = "getRelationTarget" > < span class = "type-signature" > (async) < / span > getRelationTarget< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< < a href = "Note.html" > Note< / a > >|null}< / 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" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line545" > line 545< / 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 >
< 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 >
< span class = "param-type" > Promise.< < a href = "Note.html" > Note< / a > >< / span >
|
< 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 = "Note.html" > Note< / 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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line284" > line 284< / 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 = "Note.html" > Note< / a > >>< / span >
< / dd >
< / dl >
2018-08-30 02:44:35 +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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line539" > line 539< / 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 >
< 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 >
< h4 class = "name" id = "getRevisions" > < span class = "type-signature" > (async) < / span > getRevisions< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "NoteRevision.html" > NoteRevision< / a > >>}< / span > < / h4 >
< div class = "description" >
Returns note revisions of this note.
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line687" > line 687< / 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" > Promise.< Array.< < a href = "NoteRevision.html" > NoteRevision< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getScriptEnv" > < span class = "type-signature" > < / span > getScriptEnv< span class = "signature" > ()< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line183" > line 183< / 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 >
< div class = "param-desc" >
JS script environment - either "frontend" or "backend"
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
2018-11-09 06:49:44 +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 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line235" > line 235< / a >
2018-11-09 06:49:44 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-11-09 06:49:44 +08:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
relations targetting this specific note
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
< / dd >
< / dl >
2018-08-30 02:44:35 +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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line380" > line 380< / 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 >
< 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 >
2018-09-03 22:05:28 +08:00
< h4 class = "name" id = "hasChildren" > < span class = "type-signature" > (async) < / 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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line717" > line 717< / a >
2018-09-03 22:05:28 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2018-09-03 22:05:28 +08:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
- true if note has children
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
2018-08-30 02:44:35 +08:00
< 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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line509" > line 509< / 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 >
< 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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line515" > line 515< / 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 >
< 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-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line307" > line 307< / 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
< 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 >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line173" > line 173< / 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 >
< 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 >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line165" > line 165< / 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 >
< 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 >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line160" > line 160< / 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 >
< 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 >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line155" > line 155< / 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 >
< 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-21 05:24:51 +08: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 >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line178" > line 178< / a >
2019-02-21 05:24:51 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2019-02-21 05:24:51 +08: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 >
2018-08-30 02:44:35 +08:00
< h4 class = "name" id = "loadAttributesToCache" > < span class = "type-signature" > (async) < / span > loadAttributesToCache< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line312" > line 312< / 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" > Promise.< void>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "removeAttribute" > < span class = "type-signature" > (async) < / span > removeAttribute< span class = "signature" > (type, name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< 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 >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line466" > line 466< / 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" > Promise.< void>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "removeLabel" > < span class = "type-signature" > (async) < / span > removeLabel< span class = "signature" > (name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< 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 >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line596" > line 596< / 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" > Promise.< void>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "removeRelation" > < span class = "type-signature" > (async) < / span > removeRelation< span class = "signature" > (name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< 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 >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line605" > line 605< / 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" > Promise.< void>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "setAttribute" > < span class = "type-signature" > (async) < / span > setAttribute< span class = "signature" > (type, name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
2019-11-09 05:34:30 +08:00
Update's given attribute's value or creates it if it doesn't exist
2018-08-30 02:44:35 +08: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 >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line432" > line 432< / 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" > Promise.< void>< / span >
< / dd >
< / dl >
2019-02-21 05:24:51 +08:00
< h4 class = "name" id = "setContent" > < span class = "type-signature" > (async) < / span > setContent< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line116" > line 116< / a >
2019-02-21 05:24:51 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2019-02-21 05:24:51 +08:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise< / span >
< / dd >
< / dl >
< h4 class = "name" id = "setJsonContent" > < span class = "type-signature" > (async) < / span > setJsonContent< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line150" > line 150< / a >
2019-02-21 05:24:51 +08:00
< / li > < / ul > < / dd >
< / dl >
2019-08-21 03:40:47 +08:00
2019-02-21 05:24:51 +08:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise< / span >
< / dd >
< / dl >
2018-08-30 02:44:35 +08:00
< h4 class = "name" id = "setLabel" > < span class = "type-signature" > (async) < / span > setLabel< span class = "signature" > (name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
2019-11-09 05:34:30 +08:00
Update's given label's value or creates it if it doesn't exist
2018-08-30 02:44:35 +08: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 >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line578" > line 578< / 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" > Promise.< void>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "setRelation" > < span class = "type-signature" > (async) < / span > setRelation< span class = "signature" > (name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
2019-11-09 05:34:30 +08:00
Update's given relation's value or creates it if it doesn't exist
2018-08-30 02:44:35 +08: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" > 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 >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line587" > line 587< / 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" > Promise.< void>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "toggleAttribute" > < span class = "type-signature" > (async) < / span > toggleAttribute< span class = "signature" > (type, enabled, name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< 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 >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line415" > line 415< / 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" > Promise.< void>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "toggleLabel" > < span class = "type-signature" > (async) < / span > toggleLabel< span class = "signature" > (enabled, name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< 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 >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line559" > line 559< / 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" > Promise.< void>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "toggleRelation" > < span class = "type-signature" > (async) < / span > toggleRelation< span class = "signature" > (enabled, name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< 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 >
2019-11-19 06:01:31 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line569" > line 569< / 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" > Promise.< void>< / span >
< / dd >
< / dl >
< / article >
< / section >
< / div >
< nav >
2019-08-21 03:40:47 +08:00
< h2 > < a href = "index.html" > Home< / a > < / h2 > < h3 > Classes< / h3 > < ul > < li > < a href = "ApiToken.html" > ApiToken< / a > < / li > < li > < a href = "Attribute.html" > Attribute< / a > < / li > < li > < a href = "BackendScriptApi.html" > BackendScriptApi< / a > < / li > < li > < a href = "Branch.html" > Branch< / a > < / li > < li > < a href = "Entity.html" > Entity< / a > < / li > < li > < a href = "Note.html" > Note< / a > < / li > < li > < a href = "NoteRevision.html" > NoteRevision< / a > < / li > < li > < a href = "Option.html" > Option< / a > < / li > < li > < a href = "RecentNote.html" > RecentNote< / a > < / li > < / ul > < h3 > < a href = "global.html" > Global< / a > < / h3 >
2018-08-30 02:44:35 +08:00
< / nav >
< br class = "clear" >
< footer >
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 >
