1 line
11 KiB
JavaScript
1 line
11 KiB
JavaScript
import{_ as r,c as t,a0 as a,o}from"./chunks/framework.P9qPzDnn.js";const u=JSON.parse('{"title":"Interface: TreeNodeOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/trees/tree/interfaces/TreeNodeOptions.md","filePath":"api/features/trees/tree/interfaces/TreeNodeOptions.md","lastUpdated":null}'),i={name:"api/features/trees/tree/interfaces/TreeNodeOptions.md"};function n(s,e,l,c,d,h){return o(),t("div",null,e[0]||(e[0]=[a('<p><a href="./../../../../">Profectus</a> / <a href="./../">features/trees/tree</a> / TreeNodeOptions</p><h1 id="interface-treenodeoptions" tabindex="-1">Interface: TreeNodeOptions <a class="header-anchor" href="#interface-treenodeoptions" aria-label="Permalink to "Interface: TreeNodeOptions""></a></h1><p>An object that configures a <a href="./TreeNode">TreeNode</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="extended-by" tabindex="-1">Extended by <a class="header-anchor" href="#extended-by" aria-label="Permalink to "Extended by""></a></h2><ul><li><a href="./../../../../data/common/interfaces/LayerTreeNodeOptions"><code>LayerTreeNodeOptions</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="canclick" tabindex="-1">canClick? <a class="header-anchor" href="#canclick" aria-label="Permalink to "canClick?""></a></h3><blockquote><p><code>optional</code> <strong>canClick</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>boolean</code>></p></blockquote><p>Whether or not this tree node can be clicked.</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#L26" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.tsx:26</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="color" tabindex="-1">color? <a class="header-anchor" href="#color" aria-label="Permalink to "color?""></a></h3><blockquote><p><code>optional</code> <strong>color</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>string</code>></p></blockquote><p>The background color for this node.</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#L28" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.tsx:28</a></p><hr><h3 id="display" tabindex="-1">display? <a class="header-anchor" href="#display" aria-label="Permalink to "display?""></a></h3><blockquote><p><code>optional</code> <strong>display</strong>: <a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>></p></blockquote><p>The label to display on this tree node.</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#L30" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.tsx:30</a></p><hr><h3 id="glowcolor" tabindex="-1">glowColor? <a class="header-anchor" href="#glowcolor" aria-label="Permalink to "glowColor?""></a></h3><blockquote><p><code>optional</code> <strong>glowColor</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>string</code>></p></blockquote><p>The color of the glow effect shown to notify the user there's something to do with this node.</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#L32" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.tsx:32</a></p><hr><h3 id="onclick" tabindex="-1">onClick()? <a class="header-anchor" href="#onclick" aria-label="Permalink to "onClick()?""></a></h3><blockquote><p><code>optional</code> <strong>onClick</strong>: (<code>e</code>?) => <code>void</code></p></blockquote><p>A function that is called when the tree node is clicked.</p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h4><h5 id="e" tabindex="-1">e? <a class="header-anchor" href="#e" aria-label="Permalink to "e?""></a></h5><p><a href="https://developer.mozilla.org/docs/Web/API/MouseEvent" target="_blank" rel="noreferrer"><code>MouseEvent</code></a> | <a href="https://developer.mozilla.org/docs/Web/API/TouchEvent" target="_blank" rel="noreferrer"><code>TouchEvent</code></a></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-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#L36" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.tsx:36</a></p><hr><h3 id="onhold" tabindex="-1">onHold? <a class="header-anchor" href="#onhold" aria-label="Permalink to "onHold?""></a></h3><blockquote><p><code>optional</code> <strong>onHold</strong>: <code>VoidFunction</code></p></blockquote><p>A function that is called when the tree node is held down.</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#L38" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.tsx:38</a></p><hr><h3 id="reset" tabindex="-1">reset? <a class="header-anchor" href="#reset" aria-label="Permalink to "reset?""></a></h3><blockquote><p><code>optional</code> <strong>reset</strong>: <a href="./../../../reset/interfaces/Reset"><code>Reset</code></a></p></blockquote><p>A reset object attached to this node, used for propagating resets through the tree.</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/features/trees/tree.tsx#L34" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.tsx:34</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-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#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-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" 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>',78)]))}const p=r(i,[["render",n]]);export{u as __pageData,p as default};
|