<!DOCTYPE html><htmlclass="default"lang="en"data-base="../"><head><metacharset="utf-8"/><metahttp-equiv="x-ua-compatible"content="IE=edge"/><title>NodeData | trilium</title><metaname="description"content="Documentation for trilium"/><metaname="viewport"content="width=device-width, initial-scale=1"/><linkrel="stylesheet"href="../assets/style.css"/><linkrel="stylesheet"href="../assets/highlight.css"/><scriptdefersrc="../assets/main.js"></script><scriptasyncsrc="../assets/icons.js"id="tsd-icons-script"></script><scriptasyncsrc="../assets/search.js"id="tsd-search-script"></script><scriptasyncsrc="../assets/navigation.js"id="tsd-nav-script"></script><scriptasyncsrc="../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><headerclass="tsd-page-toolbar"><divclass="tsd-toolbar-contents container"><ahref="../index.html"class="title">trilium</a><divid="tsd-toolbar-links"></div><buttonid="tsd-search-trigger"class="tsd-widget"aria-label="Search"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"aria-hidden="true"><usehref="../assets/icons.svg#icon-search"></use></svg></button><dialogid="tsd-search"aria-label="Search"><inputrole="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"/><ulrole="listbox"id="tsd-search-results"></ul><divid="tsd-search-status"aria-live="polite"aria-atomic="true"><div>Preparing search index...</div></div></dialog><ahref="#"class="tsd-widget menu"id="tsd-toolbar-menu-trigger"data-toggle="menu"aria-label="Menu"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"aria-hidden="true"><usehref="../assets/icons.svg#icon-menu"></use></svg></a></div></header><divclass="container container-main"><divclass="col-content"><divclass="tsd-page-title"><ulclass="tsd-breadcrumb"aria-label="Breadcrumb"><li><ahref="../modules/Frontend_Script_API.html">Frontend Script API</a></li><li><ahref="../modules/Frontend_Script_API._internal_.html"><internal></a></li><li><ahref=""aria-current="page">NodeData</a></li></ul><h1>Interface NodeData</h1></div><sectionclass="tsd-panel tsd-comment"><divclass="tsd-comment tsd-typography"><p>Data object passed to FancytreeNode() constructor. Note: typically these attributes are accessed by meber methods, e.g. <code>node.isExpanded()</code> and <code>node.setSelected(false)</code>.</p>
</div></section></div></details></section></section><detailsclass="tsd-panel-group tsd-member-group tsd-accordion"open><summaryclass="tsd-accordion-summary"data-key="section-Properties"><svgwidth="20"height="20"viewBox="0 0 24 24"fill="none"aria-hidden="true"><usehref="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="active"><codeclass="tsd-tag">Optional</code><span>active</span><ahref="#active"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">active</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>(initialization only, but will not be stored with the node).</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1074">src/public/app/types-fancytree.d.ts:1074</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="children"><codeclass="tsd-tag">Optional</code><span>children</span><ahref="#children"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">children</span><spanclass="tsd-signature-symbol">?:</span><ahref=""class="tsd-signature-type tsd-kind-interface">NodeData</a><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>optional array of child nodes</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1083">src/public/app/types-fancytree.d.ts:1083</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="data"><codeclass="tsd-tag">Optional</code><span>data</span><ahref="#data"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">data</span><spanclass="tsd-signature-symbol">?:</span><ahref="Backend_Script_API._internal_.Object.html"class="tsd-signature-type tsd-kind-interface">Object</a></div><divclass="tsd-comment tsd-typography"><p>all properties from will be copied to <code>node.data</code></p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1088">src/public/app/types-fancytree.d.ts:1088</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="expanded"><codeclass="tsd-tag">Optional</code><span>expanded</span><ahref="#expanded"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">expanded</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1072">src/public/app/types-fancytree.d.ts:1072</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="extraclasses"><codeclass="tsd-tag">Optional</code><span>extra<wbr/>Classes</span><ahref="#extraclasses"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">extraClasses</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>class names added to the node markup (separate with space)</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1086">src/public/app/types-fancytree.d.ts:1086</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="focus"><codeclass="tsd-tag">Optional</code><span>focus</span><ahref="#focus"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">focus</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>(initialization only, but will not be stored with the node).</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1076">src/public/app/types-fancytree.d.ts:1076</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="folder"><codeclass="tsd-tag">Optional</code><span>folder</span><ahref="#folder"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">folder</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1077">src/public/app/types-fancytree.d.ts:1077</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="hidecheckbox"><codeclass="tsd-tag">Optional</code><span>hide<wbr/>Checkbox</span><ahref="#hidecheckbox"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">hideCheckbox</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1078">src/public/app/types-fancytree.d.ts:1078</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="icon"><codeclass="tsd-tag">Optional</code><span>icon</span><ahref="#icon"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">icon</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1067">src/public/app/types-fancytree.d.ts:1067</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="icontooltip"><codeclass="tsd-tag">Optional</code><span>icon<wbr/>Tooltip</span><ahref="#icontooltip"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">iconTooltip</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>Will be added as title attribute of the node's icon span,thus enabling a tooltip.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1091">src/public/app/types-fancytree.d.ts:1091</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="key"><codeclass="tsd-tag">Optional</code><span>key</span><ahref="#key"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">key</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>unique key for this node (auto-generated if omitted)</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1069">src/public/app/types-fancytree.d.ts:1069</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="lazy"><codeclass="tsd-tag">Optional</code><span>lazy</span><ahref="#lazy"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">lazy</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1079">src/public/app/types-fancytree.d.ts:1079</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="refkey"><codeclass="tsd-tag">Optional</code><span>ref<wbr/>Key</span><ahref="#refkey"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">refKey</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>(reserved)</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1071">src/public/app/types-fancytree.d.ts:1071</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="selected"><codeclass="tsd-tag">Optional</code><span>selected</span><ahref="#selected"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">selected</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1080">src/public/app/types-fancytree.d.ts:1080</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="statusnodetype"><codeclass="tsd-tag">Optional</code><span>status<wbr/>Node<wbr/>Type</span><ahref="#statusnodetype"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">statusNodeType</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>If set, make this node a status node. Values: 'error', 'loading', 'nodata', 'paging'.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1094">src/public/app/types-fancytree.d.ts:1094</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="title"><span>title</span><ahref="#title"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">title</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>node text (may contain HTML tags)</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1066">src/public/app/types-fancytree.d.ts:1066</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="tooltip"><codeclass="tsd-tag">Optional</code><span>tooltip</span><ahref="#tooltip"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">tooltip</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">string</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1084">src/public/app/types-fancytree.d.ts:1084</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="type"><codeclass="tsd-tag">Optional</code><span>type</span><ahref="#type"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">type</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>Made available as node.type.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1097">src/public/app/types-fancytree.d.ts:1097</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="unselectable"><codeclass="tsd-tag">Optional</code><span>unselectable</span><ahref="#unselectable"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">unselectable</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1081">src/public/app/types-fancytree.d.ts:1081</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="unselectableignore"><codeclass="tsd-tag">Optional</code><span>unselectable<wbr/>Ignore</span><ahref="#unselectableignore"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">unselectableIgnore</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>Ignore this node when calculating the partsel status of parent nodes in selectMode 3 propagation.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/types-fancytree.d.ts#L1100">src/public/app/types-fancytree.d.ts:1100</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="unselectablestatus"><codeclass="tsd-tag">Optional</code><span>unselectable<wbr/>Status</span><ahref="#unselectablestatus"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">unselectableStatus</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>Use this as constant selected value(overriding selectMode 3 propagation).</p>
