1 line
15 KiB
JavaScript
1 line
15 KiB
JavaScript
import{_ as e,c as r,o as t,N as a}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Interface: LayerTreeNodeOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/data/common.LayerTreeNodeOptions.md","lastUpdated":null}'),o={name:"api/interfaces/data/common.LayerTreeNodeOptions.md"},i=a('<h1 id="interface-layertreenodeoptions" tabindex="-1">Interface: LayerTreeNodeOptions <a class="header-anchor" href="#interface-layertreenodeoptions" aria-label="Permalink to "Interface: LayerTreeNodeOptions""></a></h1><p><a href="./../../modules/data/common">data/common</a>.LayerTreeNodeOptions</p><p>An object that configures a <a href="./../../modules/data/common#layertreenode">LayerTreeNode</a></p><h2 id="hierarchy" tabindex="-1">Hierarchy <a class="header-anchor" href="#hierarchy" aria-label="Permalink to "Hierarchy""></a></h2><ul><li><p><a href="../features/trees/tree.TreeNodeOptions"><code>TreeNodeOptions</code></a></p><p>↳ <strong><code>LayerTreeNodeOptions</code></strong></p></li></ul><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="append" tabindex="-1">append <a class="header-anchor" href="#append" aria-label="Permalink to "append""></a></h3><p>• <code>Optional</code> <strong>append</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<code>boolean</code>></p><p>Whether or not to append the layer to the tabs list. If set to false, then the tree node will instead always remove all tabs to its right and then add the layer tab. Defaults to true.</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://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/data/common.tsx#L190" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:190</a></p><hr><h3 id="canclick" tabindex="-1">canClick <a class="header-anchor" href="#canclick" aria-label="Permalink to "canClick""></a></h3><p>• <code>Optional</code> <strong>canClick</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<code>boolean</code>></p><p>Whether or not this tree node can be clicked.</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="../features/trees/tree.TreeNodeOptions">TreeNodeOptions</a>.<a href="./../features/trees/tree.TreeNodeOptions#canclick">canClick</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://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/trees/tree.ts#L40" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:40</a></p><hr><h3 id="classes" tabindex="-1">classes <a class="header-anchor" href="#classes" aria-label="Permalink to "classes""></a></h3><p>• <code>Optional</code> <strong>classes</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</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><p>Dictionary of CSS classes 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="../features/trees/tree.TreeNodeOptions">TreeNodeOptions</a>.<a href="./../features/trees/tree.TreeNodeOptions#classes">classes</a></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://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/trees/tree.ts#L48" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:48</a></p><hr><h3 id="color" tabindex="-1">color <a class="header-anchor" href="#color" aria-label="Permalink to "color""></a></h3><p>• <strong>color</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<code>string</code>></p><p>The color to display this tree node as</p><h4 id="overrides" tabindex="-1">Overrides <a class="header-anchor" href="#overrides" aria-label="Permalink to "Overrides""></a></h4><p><a href="../features/trees/tree.TreeNodeOptions">TreeNodeOptions</a>.<a href="./../features/trees/tree.TreeNodeOptions#color">color</a></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://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/data/common.tsx#L180" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:180</a></p><hr><h3 id="display" tabindex="-1">display <a class="header-anchor" href="#display" aria-label="Permalink to "display""></a></h3><p>• <code>Optional</code> <strong>display</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a>></p><p>The content to display in the tree node. Defaults to the layer's ID</p><h4 id="overrides-1" tabindex="-1">Overrides <a class="header-anchor" href="#overrides-1" aria-label="Permalink to "Overrides""></a></h4><p><a href="../features/trees/tree.TreeNodeOptions">TreeNodeOptions</a>.<a href="./../features/trees/tree.TreeNodeOptions#display">display</a></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://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/data/common.tsx#L185" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:185</a></p><hr><h3 id="glowcolor" tabindex="-1">glowColor <a class="header-anchor" href="#glowcolor" aria-label="Permalink to "glowColor""></a></h3><p>• <code>Optional</code> <strong>glowColor</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<code>string</code>></p><p>The color of the glow effect shown to notify the user there's something to do with this node.</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="../features/trees/tree.TreeNodeOptions">TreeNodeOptions</a>.<a href="./../features/trees/tree.TreeNodeOptions#glowcolor">glowColor</a></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://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/trees/tree.ts#L46" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:46</a></p><hr><h3 id="layerid" tabindex="-1">layerID <a class="header-anchor" href="#layerid" aria-label="Permalink to "layerID""></a></h3><p>• <strong>layerID</strong>: <code>string</code></p><p>The ID of the layer this tree node is associated with</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://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/data/common.tsx#L178" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:178</a></p><hr><h3 id="mark" tabindex="-1">mark <a class="header-anchor" href="#mark" aria-label="Permalink to "mark""></a></h3><p>• <code>Optional</code> <strong>mark</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<code>string</code> | <code>boolean</code>></p><p>Shows a marker on the corner of the feature.</p><h4 id="inherited-from-3" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-3" aria-label="Permalink to "Inherited from""></a></h4><p><a href="../features/trees/tree.TreeNodeOptions">TreeNodeOptions</a>.<a href="./../features/trees/tree.TreeNodeOptions#mark">mark</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://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/trees/tree.ts#L52" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:52</a></p><hr><h3 id="onclick" tabindex="-1">onClick <a class="header-anchor" href="#onclick" aria-label="Permalink to "onClick""></a></h3><p>• <code>Optional</code> <strong>onClick</strong>: (<code>e?</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent" target="_blank" rel="noreferrer"><code>MouseEvent</code></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent" target="_blank" rel="noreferrer"><code>TouchEvent</code></a>) => <code>void</code></p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to "Type declaration""></a></h4><p>▸ (<code>e?</code>): <code>void</code></p><p>A function that is called when the tree node is clicked.</p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></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>e?</code></td><td style="text-align:left;"><a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent" target="_blank" rel="noreferrer"><code>MouseEvent</code></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent" target="_blank" rel="noreferrer"><code>TouchEvent</code></a></td></tr></tbody></table><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h5><p><code>void</code></p><h4 id="inherited-from-4" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-4" aria-label="Permalink to "Inherited from""></a></h4><p><a href="../features/trees/tree.TreeNodeOptions">TreeNodeOptions</a>.<a href="./../features/trees/tree.TreeNodeOptions#onclick">onClick</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://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/trees/tree.ts#L56" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:56</a></p><hr><h3 id="onhold" tabindex="-1">onHold <a class="header-anchor" href="#onhold" aria-label="Permalink to "onHold""></a></h3><p>• <code>Optional</code> <strong>onHold</strong>: <code>VoidFunction</code></p><p>A function that is called when the tree node is held down.</p><h4 id="inherited-from-5" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-5" aria-label="Permalink to "Inherited from""></a></h4><p><a href="../features/trees/tree.TreeNodeOptions">TreeNodeOptions</a>.<a href="./../features/trees/tree.TreeNodeOptions#onhold">onHold</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://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/trees/tree.ts#L58" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:58</a></p><hr><h3 id="reset" tabindex="-1">reset <a class="header-anchor" href="#reset" aria-label="Permalink to "reset""></a></h3><p>• <code>Optional</code> <strong>reset</strong>: <a href="./../../modules/features/reset#genericreset"><code>GenericReset</code></a></p><p>A reset object attached to this node, used for propagating resets through the tree.</p><h4 id="inherited-from-6" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-6" aria-label="Permalink to "Inherited from""></a></h4><p><a href="../features/trees/tree.TreeNodeOptions">TreeNodeOptions</a>.<a href="./../features/trees/tree.TreeNodeOptions#reset">reset</a></p><h4 id="defined-in-10" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-10" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/trees/tree.ts#L54" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:54</a></p><hr><h3 id="style" tabindex="-1">style <a class="header-anchor" href="#style" aria-label="Permalink to "style""></a></h3><p>• <code>Optional</code> <strong>style</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../modules/features/feature#stylevalue"><code>StyleValue</code></a>></p><p>CSS to apply to this feature.</p><h4 id="inherited-from-7" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-7" aria-label="Permalink to "Inherited from""></a></h4><p><a href="../features/trees/tree.TreeNodeOptions">TreeNodeOptions</a>.<a href="./../features/trees/tree.TreeNodeOptions#style">style</a></p><h4 id="defined-in-11" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-11" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/trees/tree.ts#L50" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:50</a></p><hr><h3 id="visibility" tabindex="-1">visibility <a class="header-anchor" href="#visibility" aria-label="Permalink to "visibility""></a></h3><p>• <code>Optional</code> <strong>visibility</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<code>boolean</code> | <a href="../../enums/features/feature.Visibility"><code>Visibility</code></a>></p><p>Whether this tree node should be visible.</p><h4 id="inherited-from-8" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-8" aria-label="Permalink to "Inherited from""></a></h4><p><a href="../features/trees/tree.TreeNodeOptions">TreeNodeOptions</a>.<a href="./../features/trees/tree.TreeNodeOptions#visibility">visibility</a></p><h4 id="defined-in-12" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-12" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/trees/tree.ts#L38" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:38</a></p>',111),n=[i];function s(d,l,c,h,f,p){return t(),r("div",null,n)}const m=e(o,[["render",s]]);export{b as __pageData,m as default};
|