1 line
9.8 KiB
JavaScript
1 line
9.8 KiB
JavaScript
import{_ as r,c as t,a0 as a,o}from"./chunks/framework.P9qPzDnn.js";const u=JSON.parse('{"title":"Interface: TreeOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/trees/tree/interfaces/TreeOptions.md","filePath":"api/features/trees/tree/interfaces/TreeOptions.md","lastUpdated":null}'),i={name:"api/features/trees/tree/interfaces/TreeOptions.md"};function s(n,e,d,c,l,h){return o(),t("div",null,e[0]||(e[0]=[a('<p><a href="./../../../../">Profectus</a> / <a href="./../">features/trees/tree</a> / TreeOptions</p><h1 id="interface-treeoptions" tabindex="-1">Interface: TreeOptions <a class="header-anchor" href="#interface-treeoptions" aria-label="Permalink to "Interface: TreeOptions""></a></h1><p>An object that configures a <a href="./Tree">Tree</a>.</p><h2 id="extends" tabindex="-1">Extends <a class="header-anchor" href="#extends" aria-label="Permalink to "Extends""></a></h2><ul><li><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a></li></ul><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="branches" tabindex="-1">branches? <a class="header-anchor" href="#branches" aria-label="Permalink to "branches?""></a></h3><blockquote><p><code>optional</code> <strong>branches</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="./TreeBranch"><code>TreeBranch</code></a>[]></p></blockquote><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 "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/trees/tree.tsx#L128" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.tsx:128</a></p><hr><h3 id="classes" tabindex="-1">classes? <a class="header-anchor" href="#classes" aria-label="Permalink to "classes?""></a></h3><blockquote><p><code>optional</code> <strong>classes</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>boolean</code>>></p></blockquote><p>Dictionary of CSS classes to apply to this feature.</p><h4 id="inherited-from" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#classes"><code>classes</code></a></p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L24" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:24</a></p><hr><h3 id="leftsidenodes" tabindex="-1">leftSideNodes? <a class="header-anchor" href="#leftsidenodes" aria-label="Permalink to "leftSideNodes?""></a></h3><blockquote><p><code>optional</code> <strong>leftSideNodes</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>TreeNode</code>[]></p></blockquote><p>Nodes to show on the left side of the tree.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/trees/tree.tsx#L124" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.tsx:124</a></p><hr><h3 id="nodes" tabindex="-1">nodes <a class="header-anchor" href="#nodes" aria-label="Permalink to "nodes""></a></h3><blockquote><p><strong>nodes</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>TreeNode</code>[][]></p></blockquote><p>The nodes within the tree, in a 2D array.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/trees/tree.tsx#L122" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.tsx:122</a></p><hr><h3 id="onreset" tabindex="-1">onReset()? <a class="header-anchor" href="#onreset" aria-label="Permalink to "onReset()?""></a></h3><blockquote><p><code>optional</code> <strong>onReset</strong>: (<code>node</code>) => <code>void</code></p></blockquote><p>A function that is called when a node within the tree is reset.</p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h4><h5 id="node" tabindex="-1">node <a class="header-anchor" href="#node" aria-label="Permalink to "node""></a></h5><p><code>TreeNode</code></p><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h4><p><code>void</code></p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/trees/tree.tsx#L132" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.tsx:132</a></p><hr><h3 id="resetpropagation" tabindex="-1">resetPropagation? <a class="header-anchor" href="#resetpropagation" aria-label="Permalink to "resetPropagation?""></a></h3><blockquote><p><code>optional</code> <strong>resetPropagation</strong>: <a href="./../type-aliases/ResetPropagation"><code>ResetPropagation</code></a></p></blockquote><p>How to propagate resets through the tree.</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/trees/tree.tsx#L130" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.tsx:130</a></p><hr><h3 id="rightsidenodes" tabindex="-1">rightSideNodes? <a class="header-anchor" href="#rightsidenodes" aria-label="Permalink to "rightSideNodes?""></a></h3><blockquote><p><code>optional</code> <strong>rightSideNodes</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>TreeNode</code>[]></p></blockquote><p>Nodes to show on the right side of the tree.</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/trees/tree.tsx#L126" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.tsx:126</a></p><hr><h3 id="style" tabindex="-1">style? <a class="header-anchor" href="#style" aria-label="Permalink to "style?""></a></h3><blockquote><p><code>optional</code> <strong>style</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="https://vuejs.org/api/utility-types.html#cssproperties" target="_blank" rel="noreferrer"><code>CSSProperties</code></a>></p></blockquote><p>CSS to apply to this feature.</p><h4 id="inherited-from-1" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-1" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#style"><code>style</code></a></p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L26" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:26</a></p><hr><h3 id="visibility" tabindex="-1">visibility? <a class="header-anchor" href="#visibility" aria-label="Permalink to "visibility?""></a></h3><blockquote><p><code>optional</code> <strong>visibility</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><boolean | Visibility></p></blockquote><p>Whether this feature should be visible.</p><h4 id="inherited-from-2" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-2" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#visibility"><code>visibility</code></a></p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L22" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:22</a></p>',70)]))}const p=r(i,[["render",s]]);export{u as __pageData,p as default};
|