2018-08-29 20:44:35 +02:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
2023-01-03 13:54:27 +01:00
< title > JSDoc: Class: FBranch< / title >
2018-08-29 20:44:35 +02:00
< 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" >
2023-01-03 13:54:27 +01:00
< h1 class = "page-title" > Class: FBranch< / h1 >
2018-08-29 20:44:35 +02:00
< section >
< header >
2023-01-03 13:54:27 +01:00
< h2 > < span class = "attribs" > < span class = "type-signature" > < / span > < / span > FBranch< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h2 >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< div class = "class-description" > Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
parents.< / div >
2018-08-29 20:44:35 +02:00
< / header >
< article >
< div class = "container-overview" >
< h2 > Constructor< / h2 >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "FBranch" > < span class = "type-signature" > < / span > new FBranch< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "entities_fbranch.js.html" > entities/fbranch.js< / a > , < a href = "entities_fbranch.js.html#line5" > line 5< / a >
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< / div >
< h3 class = "subsection-title" > Members< / h3 >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "branchId" > < span class = "type-signature" > < / span > branchId< span class = "type-signature" > :string< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< div class = "description" >
primary key
< / div >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< / li >
< / ul >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-07-27 23:22:08 +02:00
< a href = "entities_fbranch.js.html" > entities/fbranch.js< / a > , < a href = "entities_fbranch.js.html#line18" > line 18< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "froca" > < span class = "type-signature" > < / span > froca< span class = "type-signature" > :Froca< / span > < / h4 >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > Froca< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "entities_fbranch.js.html" > entities/fbranch.js< / a > , < a href = "entities_fbranch.js.html#line8" > line 8< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "fromSearchNote" > < span class = "type-signature" > < / span > fromSearchNote< span class = "type-signature" > :boolean< / span > < / h4 >
2020-03-08 11:41:42 +01:00
2021-11-10 21:30:54 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > boolean< / span >
2020-03-08 11:41:42 +01:00
2021-11-10 21:30:54 +01:00
< / li >
< / ul >
2020-03-08 11:41:42 +01:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-07-27 23:22:08 +02:00
< a href = "entities_fbranch.js.html" > entities/fbranch.js< / a > , < a href = "entities_fbranch.js.html#line30" > line 30< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-03-08 11:41:42 +01:00
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "isExpanded" > < span class = "type-signature" > < / span > isExpanded< span class = "type-signature" > :boolean< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > boolean< / span >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< / li >
< / ul >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-07-27 23:22:08 +02:00
< a href = "entities_fbranch.js.html" > entities/fbranch.js< / a > , < a href = "entities_fbranch.js.html#line28" > line 28< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "noteId" > < span class = "type-signature" > < / span > noteId< span class = "type-signature" > :string< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
< / li >
< / ul >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-07-27 23:22:08 +02:00
< a href = "entities_fbranch.js.html" > entities/fbranch.js< / a > , < a href = "entities_fbranch.js.html#line20" > line 20< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "notePosition" > < span class = "type-signature" > < / span > notePosition< span class = "type-signature" > :< a href = "global.html#int" > int< / a > < / span > < / h4 >
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#int" > int< / a > < / span >
2021-11-10 21:30:54 +01:00
< / li >
< / ul >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-07-27 23:22:08 +02:00
< a href = "entities_fbranch.js.html" > entities/fbranch.js< / a > , < a href = "entities_fbranch.js.html#line24" > line 24< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "parentNoteId" > < span class = "type-signature" > < / span > parentNoteId< span class = "type-signature" > :string< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
< / li >
< / ul >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-07-27 23:22:08 +02:00
< a href = "entities_fbranch.js.html" > entities/fbranch.js< / a > , < a href = "entities_fbranch.js.html#line22" > line 22< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "prefix" > < span class = "type-signature" > < / span > prefix< span class = "type-signature" > :string< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
< / li >
< / ul >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-07-27 23:22:08 +02:00
< a href = "entities_fbranch.js.html" > entities/fbranch.js< / a > , < a href = "entities_fbranch.js.html#line26" > line 26< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getNote" > < span class = "type-signature" > (async) < / span > getNote< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "FNote.html" > FNote< / a > }< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-07-27 23:22:08 +02:00
< a href = "entities_fbranch.js.html" > entities/fbranch.js< / a > , < a href = "entities_fbranch.js.html#line34" > line 34< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-02-02 11:44:08 +01:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "FNote.html" > FNote< / a > < / span >
2020-02-02 11:44:08 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getNoteFromCache" > < span class = "type-signature" > < / span > getNoteFromCache< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "FNote.html" > FNote< / a > }< / span > < / h4 >
2020-02-02 11:44:08 +01:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-07-27 23:22:08 +02:00
< a href = "entities_fbranch.js.html" > entities/fbranch.js< / a > , < a href = "entities_fbranch.js.html#line39" > line 39< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "FNote.html" > FNote< / a > < / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getParentNote" > < span class = "type-signature" > (async) < / span > getParentNote< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "FNote.html" > FNote< / a > }< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-07-27 23:22:08 +02:00
< a href = "entities_fbranch.js.html" > entities/fbranch.js< / a > , < a href = "entities_fbranch.js.html#line44" > line 44< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2020-09-30 22:48:30 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "FNote.html" > FNote< / a > < / span >
2020-09-30 22:48:30 +02:00
< / 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" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-07-27 23:22:08 +02:00
< a href = "entities_fbranch.js.html" > entities/fbranch.js< / a > , < a href = "entities_fbranch.js.html#line49" > line 49< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-09-30 22:48:30 +02:00
< / dl >
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2023-07-15 12:07:45 +02:00
true if it's top level, meaning its parent is the root note
2018-08-29 20:44:35 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / article >
< / section >
< / div >
< nav >
2023-08-21 04:17:16 -04:00
< h2 > < a href = "index.html" > Home< / a > < / h2 > < h3 > Classes< / h3 > < ul > < li > < a href = "BasicWidget.html" > BasicWidget< / a > < / li > < li > < a href = "FAttachment.html" > FAttachment< / a > < / li > < li > < a href = "FAttribute.html" > FAttribute< / a > < / li > < li > < a href = "FBranch.html" > FBranch< / a > < / li > < li > < a href = "FNote.html" > FNote< / a > < / li > < li > < a href = "FrontendScriptApi.html" > FrontendScriptApi< / a > < / li > < li > < a href = "NoteContextAwareWidget.html" > NoteContextAwareWidget< / a > < / li > < li > < a href = "RightPanelWidget.html" > RightPanelWidget< / a > < / li > < / ul > < h3 > Global< / h3 > < ul > < li > < a href = "global.html#api" > api< / a > < / li > < / ul >
2018-08-29 20:44:35 +02:00
< / nav >
< br class = "clear" >
< footer >
2023-05-31 14:35:08 +02:00
Documentation generated by < a href = "https://github.com/jsdoc/jsdoc" > JSDoc 4.0.2< / a >
2018-08-29 20:44:35 +02:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
