profectus-docs/assets/api_interfaces_features_trees_tree.TreeOptions.md.662ae100.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/70cda5f/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/70cda5f/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/70cda5f/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:left;"><code>node</code></td><td style="text-align:left;"><a href="./../../../modules/features/trees/tree#generictreenode"><code>GenericTreeNode</code></a></td></tr></tbody></table><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;">​</a></h5><p><code>void</code></p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/trees/tree.ts#L196" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:196</a></p><hr><h3 id="resetpropagation" tabindex="-1">resetPropagation <a class="header-anchor" href="#resetpropagation" aria-label="Permalink to &quot;resetPropagation&quot;">​</a></h3><p>• <code>Optional</code> <strong>resetPropagation</strong>: <a href="./../../../modules/features/trees/tree#resetpropagation"><code>ResetPropagation</code></a></p><p>How to propagate resets through the tree.</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/trees/tree.ts#L194" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:194</a></p><hr><h3 id="rightsidenodes" tabindex="-1">rightSideNodes <a class="header-anchor" href="#rightsidenodes" aria-label="Permalink to &quot;rightSideNodes&quot;">​</a></h3><p>• <code>Optional</code> <strong>rightSideNodes</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 right side of the tree.</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/trees/tree.ts#L190" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:190</a></p><hr><h3 id="visibility" tabindex="-1">visibility <a class="header-anchor" href="#visibility" aria-label="Permalink to &quot;visibility&quot;">​</a></h3><p>• <code>Optional</code> <strong>visibility</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>boolean</code> | <a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt;</p><p>Whether this clickable should be visible.</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/trees/tree.ts#L184" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:184</a></p>',51),i=[s];function n(d,c,h,l,f,u){return r(),t("div",null,i)}const m=e(o,[["render",n]]);export{b as __pageData,m as default};