| 
									
										
										
										
											2018-08-29 20:44:35 +02:00
										 |  |  | <!DOCTYPE html> | 
					
						
							|  |  |  | <html lang="en"> | 
					
						
							|  |  |  | <head> | 
					
						
							|  |  |  |     <meta charset="utf-8"> | 
					
						
							|  |  |  |     <title>JSDoc: Source: entities/branch.js</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">Source: entities/branch.js</h1> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |      | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |      | 
					
						
							|  |  |  |     <section> | 
					
						
							|  |  |  |         <article> | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |             <pre class="prettyprint source linenums"><code>/** | 
					
						
							|  |  |  |  * Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple | 
					
						
							|  |  |  |  * parents. | 
					
						
							|  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2018-08-29 20:44:35 +02:00
										 |  |  | class Branch { | 
					
						
							| 
									
										
										
										
											2021-04-16 22:57:37 +02:00
										 |  |  |     constructor(froca, row) { | 
					
						
							|  |  |  |         this.froca = froca; | 
					
						
							| 
									
										
										
										
											2020-02-02 11:44:08 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  |         this.update(row); | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     update(row) { | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |         /** | 
					
						
							|  |  |  |          * primary key | 
					
						
							|  |  |  |          * @type {string} | 
					
						
							|  |  |  |          */ | 
					
						
							| 
									
										
										
										
											2018-08-29 20:44:35 +02:00
										 |  |  |         this.branchId = row.branchId; | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |         /** @type {string} */ | 
					
						
							| 
									
										
										
										
											2018-08-29 20:44:35 +02:00
										 |  |  |         this.noteId = row.noteId; | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |         /** @type {string} */ | 
					
						
							| 
									
										
										
										
											2018-08-29 20:44:35 +02:00
										 |  |  |         this.parentNoteId = row.parentNoteId; | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |         /** @type {int} */ | 
					
						
							| 
									
										
										
										
											2018-08-29 20:44:35 +02:00
										 |  |  |         this.notePosition = row.notePosition; | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |         /** @type {string} */ | 
					
						
							| 
									
										
										
										
											2018-08-29 20:44:35 +02:00
										 |  |  |         this.prefix = row.prefix; | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |         /** @type {boolean} */ | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |         this.isExpanded = !!row.isExpanded; | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |         /** @type {boolean} */ | 
					
						
							| 
									
										
										
										
											2021-02-17 23:55:51 +01:00
										 |  |  |         this.fromSearchNote = !!row.fromSearchNote; | 
					
						
							| 
									
										
										
										
											2018-08-29 20:44:35 +02:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     /** @returns {NoteShort} */ | 
					
						
							|  |  |  |     async getNote() { | 
					
						
							| 
									
										
										
										
											2021-04-16 22:57:37 +02:00
										 |  |  |         return this.froca.getNote(this.noteId); | 
					
						
							| 
									
										
										
										
											2018-08-29 20:44:35 +02:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  |     /** @returns {NoteShort} */ | 
					
						
							|  |  |  |     getNoteFromCache() { | 
					
						
							| 
									
										
										
										
											2021-04-16 22:57:37 +02:00
										 |  |  |         return this.froca.getNoteFromCache(this.noteId); | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-02-02 11:44:08 +01:00
										 |  |  |     /** @returns {NoteShort} */ | 
					
						
							|  |  |  |     async getParentNote() { | 
					
						
							| 
									
										
										
										
											2021-04-16 22:57:37 +02:00
										 |  |  |         return this.froca.getNote(this.parentNoteId); | 
					
						
							| 
									
										
										
										
											2020-02-02 11:44:08 +01:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-08-29 20:44:35 +02:00
										 |  |  |     /** @returns {boolean} true if it's top level, meaning its parent is root note */ | 
					
						
							|  |  |  |     isTopLevel() { | 
					
						
							|  |  |  |         return this.parentNoteId === 'root'; | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     get toString() { | 
					
						
							|  |  |  |         return `Branch(branchId=${this.branchId})`; | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-02-17 23:55:51 +01:00
										 |  |  | export default Branch; | 
					
						
							|  |  |  | </code></pre> | 
					
						
							| 
									
										
										
										
											2018-08-29 20:44:35 +02:00
										 |  |  |         </article> | 
					
						
							|  |  |  |     </section> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | </div> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <nav> | 
					
						
							| 
									
										
										
										
											2022-06-19 14:06:00 +02:00
										 |  |  |     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> | 
					
						
							| 
									
										
										
										
											2018-08-29 20:44:35 +02:00
										 |  |  | </nav> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <br class="clear"> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <footer> | 
					
						
							| 
									
										
										
										
											2022-04-16 00:17:32 +02:00
										 |  |  |     Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> | 
					
						
							| 
									
										
										
										
											2018-08-29 20:44:35 +02:00
										 |  |  | </footer> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <script> prettyPrint(); </script> | 
					
						
							|  |  |  | <script src="scripts/linenumber.js"> </script> | 
					
						
							|  |  |  | </body> | 
					
						
							|  |  |  | </html> |