2018-08-29 20:44:35 +02:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > JSDoc: Class: Branch< / 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: Branch< / h1 >
< section >
< header >
< h2 > < span class = "attribs" > < span class = "type-signature" > < / span > < / span > Branch< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h2 >
< div class = "class-description" > Represents mapping between note and parent note< / div >
< / header >
< article >
< div class = "container-overview" >
< h2 > Constructor< / h2 >
< h4 class = "name" id = "Branch" > < span class = "type-signature" > < / span > new Branch< 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 >
< a href = "entities_branch.js.html" > entities/branch.js< / a > , < a href = "entities_branch.js.html#line2" > line 2< / a >
< / li > < / ul > < / dd >
< / dl >
< / div >
< h3 class = "subsection-title" > Members< / h3 >
< h4 class = "name" id = "branchId" > < span class = "type-signature" > < / span > branchId< span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "entities_branch.js.html" > entities/branch.js< / a > , < a href = "entities_branch.js.html#line6" > line 6< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "isExpanded" > < span class = "type-signature" > < / span > isExpanded< span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "entities_branch.js.html" > entities/branch.js< / a > , < a href = "entities_branch.js.html#line17" > line 17< / a >
< / 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 >
< a href = "entities_branch.js.html" > entities/branch.js< / a > , < a href = "entities_branch.js.html#line8" > line 8< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "notePosition" > < span class = "type-signature" > < / span > notePosition< span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "entities_branch.js.html" > entities/branch.js< / a > , < a href = "entities_branch.js.html#line13" > line 13< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "parentNoteId" > < span class = "type-signature" > < / span > parentNoteId< span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "entities_branch.js.html" > entities/branch.js< / a > , < a href = "entities_branch.js.html#line11" > line 11< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "prefix" > < span class = "type-signature" > < / span > prefix< span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "entities_branch.js.html" > entities/branch.js< / a > , < a href = "entities_branch.js.html#line15" > line 15< / a >
< / li > < / ul > < / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< h4 class = "name" id = "getNote" > < span class = "type-signature" > (async) < / span > getNote< span class = "signature" > ()< / span > < span class = "type-signature" > → {< 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 >
< a href = "entities_branch.js.html" > entities/branch.js< / a > , < a href = "entities_branch.js.html#line21" > line 21< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "NoteShort.html" > NoteShort< / a > < / span >
< / dd >
< / dl >
< h4 class = "name" id = "isTopLevel" > < span class = "type-signature" > < / span > isTopLevel< 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 >
< a href = "entities_branch.js.html" > entities/branch.js< / a > , < a href = "entities_branch.js.html#line26" > line 26< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if it's top level, meaning its parent is root note
< / div >
< 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 >
2018-11-09 20:45:28 +01:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.5.5< / a > on Fri Nov 09 2018 14:44:34 GMT+0100 (Central European Standard Time)
2018-08-29 20:44:35 +02:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
