1 line
7.3 KiB
JavaScript
1 line
7.3 KiB
JavaScript
import{_ as e,c as r,o as a,N as o}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Interface: BaseBoard","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/boards/board.BaseBoard.md","lastUpdated":null}'),t={name:"api/interfaces/features/boards/board.BaseBoard.md"},d=o('<h1 id="interface-baseboard" tabindex="-1">Interface: BaseBoard <a class="header-anchor" href="#interface-baseboard" aria-label="Permalink to "Interface: BaseBoard""></a></h1><p><a href="./../../../modules/features/boards/board">features/boards/board</a>.BaseBoard</p><p>The properties that are added onto a processed <a href="./board.BoardOptions">BoardOptions</a> to create a <a href="./../../../modules/features/boards/board#board">Board</a>.</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/boards/board.ts#L254" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:254</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/boards/board.ts#L256" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:256</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/boards/board.ts#L242" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:242</a></p><hr><h3 id="mouseposition" tabindex="-1">mousePosition <a class="header-anchor" href="#mouseposition" aria-label="Permalink to "mousePosition""></a></h3><p>• <strong>mousePosition</strong>: <code>Ref</code><<code>null</code> | { <code>x</code>: <code>number</code> ; <code>y</code>: <code>number</code> }></p><p>The current mouse position, if over the board.</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/boards/board.ts#L250" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:250</a></p><hr><h3 id="nodes" tabindex="-1">nodes <a class="header-anchor" href="#nodes" aria-label="Permalink to "nodes""></a></h3><p>• <strong>nodes</strong>: <code>Ref</code><<a href="./board.BoardNode"><code>BoardNode</code></a>[]></p><p>All the nodes currently on the board.</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/boards/board.ts#L244" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:244</a></p><hr><h3 id="selectedaction" tabindex="-1">selectedAction <a class="header-anchor" href="#selectedaction" aria-label="Permalink to "selectedAction""></a></h3><p>• <strong>selectedAction</strong>: <code>Ref</code><<code>null</code> | <a href="./../../../modules/features/boards/board#genericboardnodeaction"><code>GenericBoardNodeAction</code></a>></p><p>The currently selected action, if any.</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/boards/board.ts#L248" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:248</a></p><hr><h3 id="selectednode" tabindex="-1">selectedNode <a class="header-anchor" href="#selectednode" aria-label="Permalink to "selectedNode""></a></h3><p>• <strong>selectedNode</strong>: <code>Ref</code><<code>null</code> | <a href="./board.BoardNode"><code>BoardNode</code></a>></p><p>The currently selected node, if any.</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/boards/board.ts#L246" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:246</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/boards/board#boardtype"><code>BoardType</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/boards/board.ts#L252" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:252</a></p>',55),n=[d];function s(i,c,h,l,f,p){return a(),r("div",null,n)}const g=e(t,[["render",s]]);export{b as __pageData,g as default};
|