2025-04-13 18:48:04 +03:00
<!DOCTYPE html> < html class = "default" lang = "en" data-base = "../" > < head > < meta charset = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > FBranch | trilium< / title > < meta name = "description" content = "Documentation for trilium" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / > < link rel = "stylesheet" href = "../assets/style.css" / > < link rel = "stylesheet" href = "../assets/highlight.css" / > < script defer src = "../assets/main.js" > < / script > < script async src = "../assets/icons.js" id = "tsd-icons-script" > < / script > < script async src = "../assets/search.js" id = "tsd-search-script" > < / script > < script async src = "../assets/navigation.js" id = "tsd-nav-script" > < / script > < script async src = "../assets/hierarchy.js" id = "tsd-hierarchy-script" > < / script > < / head > < body > < script > document . documentElement . dataset . theme = localStorage . getItem ( "tsd-theme" ) || "os" ; document . body . style . display = "none" ; setTimeout ( ( ) => window . app ? app . showPage ( ) : document . body . style . removeProperty ( "display" ) , 500 ) < / script > < header class = "tsd-page-toolbar" > < div class = "tsd-toolbar-contents container" > < a href = "../index.html" class = "title" > trilium< / a > < div id = "tsd-toolbar-links" > < / div > < button id = "tsd-search-trigger" class = "tsd-widget" aria-label = "Search" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-search" > < / use > < / svg > < / button > < dialog id = "tsd-search" aria-label = "Search" > < input role = "combobox" id = "tsd-search-input" aria-controls = "tsd-search-results" aria-autocomplete = "list" aria-expanded = "true" autocapitalize = "off" autocomplete = "off" placeholder = "Search the docs" maxLength = "100" / > < ul role = "listbox" id = "tsd-search-results" > < / ul > < div id = "tsd-search-status" aria-live = "polite" aria-atomic = "true" > < div > Preparing search index...< / div > < / div > < / dialog > < a href = "#" class = "tsd-widget menu" id = "tsd-toolbar-menu-trigger" data-toggle = "menu" aria-label = "Menu" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-menu" > < / use > < / svg > < / a > < / div > < / header > < div class = "container container-main" > < div class = "col-content" > < div class = "tsd-page-title" > < ul class = "tsd-breadcrumb" aria-label = "Breadcrumb" > < li > < a href = "../modules/Frontend_Script_API.html" > Frontend Script API< / a > < / li > < li > < a href = "" aria-current = "page" > FBranch< / a > < / li > < / ul > < h1 > Class FBranch< / h1 > < / div > < section class = "tsd-panel tsd-comment" > < div class = "tsd-comment tsd-typography" > < p > Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
2025-04-12 13:30:24 +03:00
parents.< / p >
2025-04-13 18:59:52 +03:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / section > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/entities/fbranch.ts#L18" > src/public/app/entities/fbranch.ts:18< / a > < / li > < / ul > < / aside > < section class = "tsd-panel-group tsd-index-group" > < section class = "tsd-panel tsd-index-panel" > < details class = "tsd-index-content tsd-accordion" open > < summary class = "tsd-accordion-summary tsd-index-summary" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronSmall" > < / use > < / svg > < h5 class = "tsd-index-heading uppercase" > Index< / h5 > < / summary > < div class = "tsd-accordion-details" > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Constructors< / h3 > < div class = "tsd-index-list" > < a href = "#constructor" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Constructor" > < use href = "../assets/icons.svg#icon-512" > < / use > < / svg > < span > constructor< / span > < / a >
2025-04-12 13:30:24 +03:00
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Properties< / h3 > < div class = "tsd-index-list" > < a href = "#branchid" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > branch< wbr / > Id< / span > < / a >
< a href = "#fromsearchnote" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > from< wbr / > Search< wbr / > Note< / span > < / a >
< a href = "#isexpanded" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > is< wbr / > Expanded?< / span > < / a >
< a href = "#noteid" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > note< wbr / > Id< / span > < / a >
< a href = "#noteposition" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > note< wbr / > Position< / span > < / a >
< a href = "#parentnoteid" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > parent< wbr / > Note< wbr / > Id< / span > < / a >
< a href = "#prefix" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > prefix?< / span > < / a >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Accessors< / h3 > < div class = "tsd-index-list" > < a href = "#pojo" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Accessor" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > pojo< / span > < / a >
< a href = "#tostring" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Accessor" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > to< wbr / > String< / span > < / a >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Methods< / h3 > < div class = "tsd-index-list" > < a href = "#getnote" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Note< / span > < / a >
< a href = "#getnotefromcache" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Note< wbr / > From< wbr / > Cache< / span > < / a >
< a href = "#getparentnote" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Parent< wbr / > Note< / span > < / a >
< a href = "#istoplevel" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > is< wbr / > Top< wbr / > Level< / span > < / a >
< a href = "#update" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > update< / span > < / a >
2025-04-13 18:59:52 +03:00
< / div > < / section > < / div > < / details > < / section > < / section > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Constructors" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > < h2 > Constructors< / h2 > < / summary > < section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "constructor" > < span > constructor< / span > < a href = "#constructor" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "" > < div class = "tsd-signature tsd-anchor-link" id = "constructorfbranch" > < span class = "tsd-signature-keyword" > new< / span > < span class = "tsd-kind-constructor-signature" > FBranch< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > froca< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "../interfaces/Frontend_Script_API._internal_.Froca.html" class = "tsd-signature-type tsd-kind-interface" > Froca< / a > < span class = "tsd-signature-symbol" > ,< / span > < span class = "tsd-kind-parameter" > row< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "../interfaces/Frontend_Script_API._internal_.FBranchRow.html" class = "tsd-signature-type tsd-kind-interface" > FBranchRow< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "" class = "tsd-signature-type tsd-kind-class" > FBranch< / a > < a href = "#constructorfbranch" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / div > < div class = "tsd-description" > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > froca< / span > : < a href = "../interfaces/Frontend_Script_API._internal_.Froca.html" class = "tsd-signature-type tsd-kind-interface" > Froca< / a > < / span > < / li > < li > < span > < span class = "tsd-kind-parameter" > row< / span > : < a href = "../interfaces/Frontend_Script_API._internal_.FBranchRow.html" class = "tsd-signature-type tsd-kind-interface" > FBranchRow< / a > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "" class = "tsd-signature-type tsd-kind-class" > FBranch< / a > < / h4 > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/entities/fbranch.ts#L32" > src/public/app/entities/fbranch.ts:32< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < / section > < / details > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Properties" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > < h2 > Properties< / h2 > < / summary > < section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "branchid" > < span > branch< wbr / > Id< / span > < a href = "#branchid" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > branchId< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > primary key< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/entities/fbranch.ts#L24" > src/public/app/entities/fbranch.ts:24< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "fromsearchnote" > < span > from< wbr / > Search< wbr / > Note< / span > < a href = "#fromsearchnote" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > fromSearchNote< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/entities/fbranch.ts#L30" > src/public/app/entities/fbranch.ts:30< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "isexpanded" > < code class = "tsd-tag" > Optional< / code > < span > is< wbr / > Expanded< / span > < a href = "#isexpanded" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > isExpanded< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/entities/fbranch.ts#L29" > src/public/app/entities/fbranch.ts:29< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "noteid" > < span > note< wbr / > Id< / span > < a href = "#noteid" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > noteId< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/entities/fbranch.ts#L25" > src/public/app/entities/fbranch.ts:25< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "noteposition" > < span > note< wbr / > Position< / span > < a href = "#noteposition" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > notePosition< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/entities/fbranch.ts#L27" > src/public/app/entities/fbranch.ts:27< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "parentnoteid" > < span > parent< wbr / > Note< wbr / > Id< / span > < a href = "#parentnoteid" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > parentNoteId< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/entities/fbranch.ts#L26" > src/public/app/entities/fbranch.ts:26< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "prefix" > < code class = "tsd-tag" > Optional< / code > < span > prefix< / span > < a href = "#prefix" aria-label = "Permalink" class = "tsd-an
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/entities/fbranch.ts#L64" > src/public/app/entities/fbranch.ts:64< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "update" > < span > update< / span > < a href = "#update" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "" > < div class = "tsd-signature tsd-anchor-link" id = "update-1" > < span class = "tsd-kind-call-signature" > update< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > row< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "../interfaces/Frontend_Script_API._internal_.FBranchRow.html" class = "tsd-signature-type tsd-kind-interface" > FBranchRow< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > void< / span > < a href = "#update-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / div > < div class = "tsd-description" > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > row< / span > : < a href = "../interfaces/Frontend_Script_API._internal_.FBranchRow.html" class = "tsd-signature-type tsd-kind-interface" > FBranchRow< / a > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/entities/fbranch.ts#L38" > src/public/app/entities/fbranch.ts:38< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < / section > < / details > < / div > < div class = "col-sidebar" > < div class = "page-menu" > < div class = "tsd-navigation settings" > < details class = "tsd-accordion" > < summary class = "tsd-accordion-summary" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > < h3 > Settings< / h3 > < / summary > < div class = "tsd-accordion-details" > < div class = "tsd-filter-visibility" > < span class = "settings-label" > Member Visibility< / span > < ul id = "tsd-filter-options" > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-protected" name = "protected" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Protected< / span > < / label > < / li > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-inherited" name = "inherited" checked / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Inherited< / span > < / label > < / li > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-external" name = "external" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > External< / span > < / label > < / li > < / ul > < / div > < div class = "tsd-theme-toggle" > < label class = "settings-label" for = "tsd-theme" > Theme< / label > < select id =
