trilium/docs/frontend_api/entities_branch.js.html

109 lines
2.8 KiB
HTML
Raw Normal View History

2018-08-30 02:44:35 +08: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>
<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-30 02:44:35 +08:00
class Branch {
2021-04-17 04:57:37 +08:00
constructor(froca, row) {
this.froca = froca;
2020-02-02 18:44:08 +08:00
this.update(row);
}
update(row) {
/**
* primary key
* @type {string}
*/
2018-08-30 02:44:35 +08:00
this.branchId = row.branchId;
/** @type {string} */
2018-08-30 02:44:35 +08:00
this.noteId = row.noteId;
/** @type {string} */
2018-08-30 02:44:35 +08:00
this.parentNoteId = row.parentNoteId;
/** @type {int} */
2018-08-30 02:44:35 +08:00
this.notePosition = row.notePosition;
/** @type {string} */
2018-08-30 02:44:35 +08:00
this.prefix = row.prefix;
/** @type {boolean} */
2018-12-23 05:28:49 +08:00
this.isExpanded = !!row.isExpanded;
/** @type {boolean} */
this.fromSearchNote = !!row.fromSearchNote;
2018-08-30 02:44:35 +08:00
}
/** @returns {NoteShort} */
async getNote() {
2021-04-17 04:57:37 +08:00
return this.froca.getNote(this.noteId);
2018-08-30 02:44:35 +08:00
}
2020-10-01 04:48:30 +08:00
/** @returns {NoteShort} */
getNoteFromCache() {
2021-04-17 04:57:37 +08:00
return this.froca.getNoteFromCache(this.noteId);
2020-10-01 04:48:30 +08:00
}
2020-02-02 18:44:08 +08:00
/** @returns {NoteShort} */
async getParentNote() {
2021-04-17 04:57:37 +08:00
return this.froca.getNote(this.parentNoteId);
2020-02-02 18:44:08 +08:00
}
2018-08-30 02:44:35 +08: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})`;
}
}
export default Branch;
</code></pre>
2018-08-30 02:44:35 +08:00
</article>
</section>
</div>
<nav>
<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-30 02:44:35 +08:00
</nav>
<br class="clear">
<footer>
2022-04-16 06:17:32 +08:00
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
2018-08-30 02:44:35 +08:00
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>