1 line
7.9 KiB
JavaScript
1 line
7.9 KiB
JavaScript
import{_ as e,c as t,o as r,N as a}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Interface: BaseTree","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/trees/tree.BaseTree.md","lastUpdated":null}'),o={name:"api/interfaces/features/trees/tree.BaseTree.md"},n=a('<h1 id="interface-basetree" tabindex="-1">Interface: BaseTree <a class="header-anchor" href="#interface-basetree" aria-label="Permalink to "Interface: BaseTree""></a></h1><p><a href="./../../../modules/features/trees/tree">features/trees/tree</a>.BaseTree</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="component" tabindex="-1">[Component] <a class="header-anchor" href="#component" aria-label="Permalink to "[Component]""></a></h3><p>• <strong>[Component]</strong>: <a href="./../../../modules/features/feature#genericcomponent"><code>GenericComponent</code></a></p><p>The Vue component used to render this feature.</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/70cda5f/src/features/trees/tree.ts#L213" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:213</a></p><hr><h3 id="gatherprops" tabindex="-1">[GatherProps] <a class="header-anchor" href="#gatherprops" aria-label="Permalink to "[GatherProps]""></a></h3><p>• <strong>[GatherProps]</strong>: () => <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>unknown</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>▸ (): <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>unknown</code>></p><p>A function to gather the props the vue component requires for this feature.</p><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h5><p><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>unknown</code>></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/70cda5f/src/features/trees/tree.ts#L215" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:215</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to "id""></a></h3><p>• <strong>id</strong>: <code>string</code></p><p>An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.</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/70cda5f/src/features/trees/tree.ts#L201" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:201</a></p><hr><h3 id="isresetting" tabindex="-1">isResetting <a class="header-anchor" href="#isresetting" aria-label="Permalink to "isResetting""></a></h3><p>• <strong>isResetting</strong>: <code>Ref</code><<code>boolean</code>></p><p>A flag that is true while the reset is still propagating through the tree.</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/70cda5f/src/features/trees/tree.ts#L207" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:207</a></p><hr><h3 id="links" tabindex="-1">links <a class="header-anchor" href="#links" aria-label="Permalink to "links""></a></h3><p>• <strong>links</strong>: <code>Ref</code><<a href="../links/links.Link"><code>Link</code></a>[]></p><p>The link objects for each of the branches of the tree.</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/70cda5f/src/features/trees/tree.ts#L203" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:203</a></p><hr><h3 id="reset" tabindex="-1">reset <a class="header-anchor" href="#reset" aria-label="Permalink to "reset""></a></h3><p>• <strong>reset</strong>: (<code>node</code>: <a href="./../../../modules/features/trees/tree#generictreenode"><code>GenericTreeNode</code></a>) => <code>void</code></p><h4 id="type-declaration-1" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration-1" aria-label="Permalink to "Type declaration""></a></h4><p>▸ (<code>node</code>): <code>void</code></p><p>Cause a reset on this node and propagate it through the tree according to resetPropagation.</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>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-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to "Returns""></a></h5><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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/trees/tree.ts#L205" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:205</a></p><hr><h3 id="resettingnode" tabindex="-1">resettingNode <a class="header-anchor" href="#resettingnode" aria-label="Permalink to "resettingNode""></a></h3><p>• <strong>resettingNode</strong>: <code>Ref</code><<code>null</code> | <a href="./../../../modules/features/trees/tree#generictreenode"><code>GenericTreeNode</code></a>></p><p>A reference to the node that caused the currently propagating reset.</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/70cda5f/src/features/trees/tree.ts#L209" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:209</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-label="Permalink to "type""></a></h3><p>• <strong>type</strong>: typeof <a href="./../../../modules/features/trees/tree#treetype"><code>TreeType</code></a></p><p>A symbol that helps identify features of the same type.</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/70cda5f/src/features/trees/tree.ts#L211" target="_blank" rel="noreferrer">profectus/src/features/trees/tree.ts:211</a></p>',60),s=[n];function i(d,c,h,l,f,p){return r(),t("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default};
|