profectus-docs/assets/api_interfaces_features_trees_tree.TreeOptions.md.56d1c568.js

import{_ as e,c as t,o as r,N as a}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Interface: TreeOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/trees/tree.TreeOptions.md","lastUpdated":null}'),o={name:"api/interfaces/features/trees/tree.TreeOptions.md"},s=a('<h1 id="interface-treeoptions" tabindex="-1">Interface: TreeOptions <a class="header-anchor" href="#interface-treeoptions" aria-label="Permalink to &quot;Interface: TreeOptions&quot;">​</a></h1><p><a href="./../../../modules/features/trees/tree">features/trees/tree</a>.TreeOptions</p><p>An object that configures a <a href="./../../../modules/features/trees/tree#tree">Tree</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to &quot;Properties&quot;">​</a></h2><h3 id="branches" tabindex="-1">branches <a class="header-anchor" href="#branches" aria-label="Permalink to &quot;branches&quot;">​</a></h3><p>• <code>Optional</code> <strong>branches</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./tree.TreeBranch"><code>TreeBranch</code></a>[]&gt;</p><p>The branches between nodes within this tree.</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/trees/tree.ts#L192" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:192</a></p><hr><h3 id="leftsidenodes" tabindex="-1">leftSideNodes <a class="header-anchor" href="#leftsidenodes" aria-label="Permalink to &quot;leftSideNodes&quot;">​</a></h3><p>• <code>Optional</code> <strong>leftSideNodes</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../../modules/features/trees/tree#generictreenode"><code>GenericTreeNode</code></a>[]&gt;</p><p>Nodes to show on the left side of the tree.</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/trees/tree.ts#L188" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:188</a></p><hr><h3 id="nodes" tabindex="-1">nodes <a class="header-anchor" href="#nodes" aria-label="Permalink to &quot;nodes&quot;">​</a></h3><p>• <strong>nodes</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../../modules/features/trees/tree#generictreenode"><code>GenericTreeNode</code></a>[][]&gt;</p><p>The nodes within the tree, in a 2D array.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/trees/tree.ts#L186" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:186</a></p><hr><h3 id="onreset" tabindex="-1">onReset <a class="header-anchor" href="#onreset" aria-label="Permalink to &quot;onReset&quot;">​</a></h3><p>• <code>Optional</code> <strong>onReset</strong>: (<code>node</code>: <a href="./../../../modules/features/trees/tree#generictreenode"><code>GenericTreeNode</code></a>) =&gt; <code>void</code></p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to &quot;Type declaration&quot;">​</a></h4><p>▸ (<code>node</code>): <code>void</code></p><p>A function that is called when a node within the tree is reset.</p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;">​</a></h5><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:le