profectus/profectus-docs
1
0
Fork 0
Code Issues 12 Pull requests Projects 1 Releases Packages Wiki Activity Actions
profectus-docs/assets/api_modules_features_boards_board.md.db81d579.js

1 line
25 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Module: features/boards/board","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/boards/board.md","lastUpdated":null}'),d={name:"api/modules/features/boards/board.md"},r=o('<h1 id="module-features-boards-board" tabindex="-1">Module: features/boards/board <a class="header-anchor" href="#module-features-boards-board" aria-label="Permalink to &quot;Module: features/boards/board&quot;">​</a></h1><h2 id="components" tabindex="-1">Components <a class="header-anchor" href="#components" aria-label="Permalink to &quot;Components&quot;">​</a></h2><ul><li><a href="./BoardComponent">Board</a></li><li><a href="./BoardLinkComponent">BoardLink</a></li><li><a href="./BoardNodeComponent">BoardNode</a></li></ul><h2 id="enumerations" tabindex="-1">Enumerations <a class="header-anchor" href="#enumerations" aria-label="Permalink to &quot;Enumerations&quot;">​</a></h2><ul><li><a href="../../../enums/features/boards/board.ProgressDisplay">ProgressDisplay</a></li><li><a href="../../../enums/features/boards/board.Shape">Shape</a></li></ul><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to &quot;Interfaces&quot;">​</a></h2><ul><li><a href="../../../interfaces/features/boards/board.BaseBoard">BaseBoard</a></li><li><a href="../../../interfaces/features/boards/board.BaseBoardNodeAction">BaseBoardNodeAction</a></li><li><a href="../../../interfaces/features/boards/board.BaseNodeType">BaseNodeType</a></li><li><a href="../../../interfaces/features/boards/board.BoardNode">BoardNode</a></li><li><a href="../../../interfaces/features/boards/board.BoardNodeActionOptions">BoardNodeActionOptions</a></li><li><a href="../../../interfaces/features/boards/board.BoardNodeLink">BoardNodeLink</a></li><li><a href="../../../interfaces/features/boards/board.BoardOptions">BoardOptions</a></li><li><a href="../../../interfaces/features/boards/board.NodeLabel">NodeLabel</a></li><li><a href="../../../interfaces/features/boards/board.NodeTypeOptions">NodeTypeOptions</a></li></ul><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-label="Permalink to &quot;Type Aliases&quot;">​</a></h2><h3 id="board" tabindex="-1">Board <a class="header-anchor" href="#board" aria-label="Permalink to &quot;Board&quot;">​</a></h3><p>Ƭ <strong>Board</strong>&lt;<code>T</code>&gt;: <a href="./../feature#replace"><code>Replace</code></a>&lt;<code>T</code> &amp; <a href="../../../interfaces/features/boards/board.BaseBoard"><code>BaseBoard</code></a>, { <code>classes</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;classes&quot;</code>]&gt; ; <code>height</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;height&quot;</code>]&gt; ; <code>links</code>: <a href="./../../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;links&quot;</code>], <code>Ref</code>&lt;<a href="../../../interfaces/features/boards/board.BoardNodeLink"><code>BoardNodeLink</code></a>[] | <code>null</code>&gt;&gt; ; <code>state</code>: <a href="./../../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;state&quot;</code>], <a href="./../../game/persistence#persistent"><code>Persistent</code></a>&lt;<a href="./board#boarddata"><code>BoardData</code></a>&gt;&gt; ; <code>style</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;style&quot;</code>]&gt; ; <code>types</code>: <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a>&lt;<code>string</code>, <a href="./board#genericnodetype"><code>GenericNodeType</code></a>&gt; ; <code>visibility</code>: <a href="./../../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;visibility&quot;</code>], <a href="./../../../enums/features/feature.Visibility#visible"><code>Visible</code></a>&gt; ; <code>width</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;width&quot;</code>]&gt; }&gt;</p><p>An object that represents a feature that is a zoomable, pannable board with various nodes upon it.</p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to &quot;Type parameters&quot;">​</a></h4><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>T</code></td><td style="text-align:left;">extends <a href="../../../interfaces/features/boards/board.BoardOptions"><code>BoardOptions</code></a></td></tr></tbody></table><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L260" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:260</a></p><hr><h3 id="boarddata" tabindex="-1">BoardData <a class="header-anchor" href="#boarddata" aria-label="Permalink to &quot;BoardData&quot;">​</a></h3><p>Ƭ <strong>BoardData</strong>: <code>Object</code></p><p>The persistent data for a board.</p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to &quot;Type declaration&quot;">​</a></h4><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>nodes</code></td><td style="text-align:left;"><a href="../../../interfaces/features/boards/board.BoardNode"><code>BoardNode</code></a>[]</td></tr><tr><td style="text-align:left;"><code>selectedAction</code></td><td style="text-align:left;"><code>string</code> | <code>null</code></td></tr><tr><td style="text-align:left;"><code>selectedNode</code></td><td style="text-align:left;"><code>number</code> | <code>null</code></td></tr></tbody></table><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L77" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:77</a></p><hr><h3 id="boardnodeaction" tabindex="-1">BoardNodeAction <a class="header-anchor" href="#boardnodeaction" aria-label="Permalink to &quot;BoardNodeAction&quot;">​</a></h3><p>Ƭ <strong>BoardNodeAction</strong>&lt;<code>T</code>&gt;: <a href="./../feature#replace"><code>Replace</code></a>&lt;<code>T</code> &amp; <a href="../../../interfaces/features/boards/board.BaseBoardNodeAction"><code>BaseBoardNodeAction</code></a>, { <code>fillColor</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;fillColor&quot;</code>]&gt; ; <code>icon</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;icon&quot;</code>]&gt; ; <code>links</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;links&quot;</code>]&gt; ; <code>tooltip</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;tooltip&quot;</code>]&gt; ; <code>visibility</code>: <a href="./../../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;visibility&quot;</code>], <a href="./../../../enums/features/feature.Visibility#visible"><code>Visible</code></a>&gt; }&gt;</p><p>An object that represents an action that can be taken upon a node.</p><h4 id="type-parameters-1" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-1" aria-label="Permalink to &quot;Type parameters&quot;">​</a></h4><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>T</code></td><td style="text-align:left;">extends <a href="../../../interfaces/features/boards/board.BoardNodeActionOptions"><code>BoardNodeActionOptions</code></a></td></tr></tbody></table><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L194" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:194</a></p><hr><h3 id="genericboard" tabindex="-1">GenericBoard <a class="header-anchor" href="#genericboard" aria-label="Permalink to &quot;GenericBoard&quot;">​</a></h3><p>Ƭ <strong>GenericBoard</strong>: <a href="./../feature#replace"><code>Replace</code></a>&lt;<a href="./board#board"><code>Board</code></a>&lt;<a href="../../../interfaces/features/boards/board.BoardOptions"><code>BoardOptions</code></a>&gt;, { <code>links</code>: <a href="./../../util/computed#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../../interfaces/features/boards/board.BoardNodeLink"><code>BoardNodeLink</code></a>[] | <code>null</code>&gt; ; <code>state</code>: <a href="./../../util/computed#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="./board#boarddata"><code>BoardData</code></a>&gt; ; <code>visibility</code>: <a href="./../../util/computed#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a> | <code>boolean</code>&gt; }&gt;</p><p>A type that matches any valid <a href="./board#board">Board</a> object.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L275" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:275</a></p><hr><h3 id="genericboardnodeaction" tabindex="-1">GenericBoardNodeAction <a class="header-anchor" href="#genericboardnodeaction" aria-label="Permalink to &quot;GenericBoardNodeAction&quot;">​</a></h3><p>Ƭ <strong>GenericBoardNodeAction</strong>: <a href="./../feature#replace"><code>Replace</code></a>&lt;<a href="./board#boardnodeaction"><code>BoardNodeAction</code></a>&lt;<a href="../../../interfaces/features/boards/board.BoardNodeActionOptions"><code>BoardNodeActionOptions</code></a>&gt;, { <code>visibility</code>: <a href="./board#nodecomputable"><code>NodeComputable</code></a>&lt;<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a> | <code>boolean</code>&gt; }&gt;</p><p>A type that matches any valid <a href="./board#boardnodeaction">BoardNodeAction</a> object.</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L206" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:206</a></p><hr><h3 id="genericnodetype" tabindex="-1">GenericNodeType <a class="header-anchor" href="#genericnodetype" aria-label="Permalink to &quot;GenericNodeType&quot;">​</a></h3><p>Ƭ <strong>GenericNodeType</strong>: <a href="./../feature#replace"><code>Replace</code></a>&lt;<a href="./board#nodetype"><code>NodeType</code></a>&lt;<a href="../../../interfaces/features/boards/board.NodeTypeOptions"><code>NodeTypeOptions</code></a>&gt;, { <code>actionDistance</code>: <a href="./board#nodecomputable"><code>NodeComputable</code></a>&lt;<code>number</code>&gt; ; <code>canAccept</code>: <a href="./board#nodecomputable"><code>NodeComputable</code></a>&lt;<code>boolean</code>&gt; ; <code>draggable</code>: <a href="./board#nodecomputable"><code>NodeComputable</code></a>&lt;<code>boolean</code>&gt; ; <code>progressColor</code>: <a href="./board#nodecomputable"><code>NodeComputable</code></a>&lt;<code>string</code>&gt; ; <code>progressDisplay</code>: <a href="./board#nodecomputable"><code>NodeComputable</code></a>&lt;<a href="../../../enums/features/boards/board.ProgressDisplay"><code>ProgressDisplay</code></a>&gt; ; <code>shape</code>: <a href="./board#nodecomputable"><code>NodeComputable</code></a>&lt;<a href="../../../enums/features/boards/board.Shape"><code>Shape</code></a>&gt; ; <code>size</code>: <a href="./board#nodecomputable"><code>NodeComputable</code></a>&lt;<code>number</code>&gt; }&gt;</p><p>A type that matches any valid <a href="./board#nodetype">NodeType</a> object.</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L153" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:153</a></p><hr><h3 id="nodecomputable" tabindex="-1">NodeComputable <a class="header-anchor" href="#nodecomputable" aria-label="Permalink to &quot;NodeComputable&quot;">​</a></h3><p>Ƭ <strong>NodeComputable</strong>&lt;<code>T</code>&gt;: <a href="./../../util/computed#computable"><code>Computable</code></a>&lt;<code>T</code>&gt; | (<code>node</code>: <a href="../../../interfaces/features/boards/board.BoardNode"><code>BoardNode</code></a>) =&gt; <code>T</code></p><p>A type representing a computable value for a node on the board. Used for node types to return different values based on the given node and the state of the board.</p><h4 id="type-parameters-2" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-2" aria-label="Permalink to &quot;Type parameters&quot;">​</a></h4><table><thead><tr><th style="text-align:left;">Name</th></tr></thead><tbody><tr><td style="text-align:left;"><code>T</code></td></tr></tbody></table><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L36" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:36</a></p><hr><h3 id="nodetype" tabindex="-1">NodeType <a class="header-anchor" href="#nodetype" aria-label="Permalink to &quot;NodeType&quot;">​</a></h3><p>Ƭ <strong>NodeType</strong>&lt;<code>T</code>&gt;: <a href="./../feature#replace"><code>Replace</code></a>&lt;<code>T</code> &amp; <a href="../../../interfaces/features/boards/board.BaseNodeType"><code>BaseNodeType</code></a>, { <code>actionDistance</code>: <a href="./../../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;actionDistance&quot;</code>], <code>number</code>&gt; ; <code>actions?</code>: <a href="./board#genericboardnodeaction"><code>GenericBoardNodeAction</code></a>[] ; <code>canAccept</code>: <a href="./../../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;canAccept&quot;</code>], <code>false</code>&gt; ; <code>draggable</code>: <a href="./../../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;draggable&quot;</code>], <code>false</code>&gt; ; <code>fillColor</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;fillColor&quot;</code>]&gt; ; <code>label</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;label&quot;</code>]&gt; ; <code>outlineColor</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;outlineColor&quot;</code>]&gt; ; <code>progress</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;progress&quot;</code>]&gt; ; <code>progressColor</code>: <a href="./../../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;progressColor&quot;</code>], <code>&quot;none&quot;</code>&gt; ; <code>progressDisplay</code>: <a href="./../../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;progressDisplay&quot;</code>], <a href="./../../../enums/features/boards/board.ProgressDisplay#fill"><code>Fill</code></a>&gt; ; <code>shape</code>: <a href="./../../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;shape&quot;</code>], <a href="./../../../enums/features/boards/board.Shape#circle"><code>Circle</code></a>&gt; ; <code>size</code>: <a href="./../../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;size&quot;</code>], <code>50</code>&gt; ; <code>title</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;title&quot;</code>]&gt; ; <code>titleColor</code>: <a href="./../../util/computed#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;titleColor&quot;</code>]&gt; }&gt;</p><p>An object that represents a type of node that can appear on a board. It will handle getting properties and callbacks for every node of that type.</p><h4 id="type-parameters-3" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-3" aria-label="Permalink to &quot;Type parameters&quot;">​</a></h4><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>T</code></td><td style="text-align:left;">extends <a href="../../../interfaces/features/boards/board.NodeTypeOptions"><code>NodeTypeOptions</code></a></td></tr></tbody></table><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L132" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:132</a></p><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-label="Permalink to &quot;Variables&quot;">​</a></h2><h3 id="boardtype" tabindex="-1">BoardType <a class="header-anchor" href="#boardtype" aria-label="Permalink to &quot;BoardType&quot;">​</a></h3><p>• <code>Const</code> <strong>BoardType</strong>: typeof <a href="./board#boardtype"><code>BoardType</code></a></p><p>A symbol used to identify <a href="./board#board">Board</a> features.</p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L31" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:31</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-label="Permalink to &quot;Functions&quot;">​</a></h2><h3 id="createboard" tabindex="-1">createBoard <a class="header-anchor" href="#createboard" aria-label="Permalink to &quot;createBoard&quot;">​</a></h3><p>▸ <strong>createBoard</strong>&lt;<code>T</code>&gt;(<code>optionsFunc</code>): <a href="./board#board"><code>Board</code></a>&lt;<code>T</code>&gt;</p><p>Lazily creates a board with the given options.</p><h4 id="type-parameters-4" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-4" aria-label="Permalink to &quot;Type parameters&quot;">​</a></h4><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>T</code></td><td style="text-align:left;">extends <a href="../../../interfaces/features/boards/board.BoardOptions"><code>BoardOptions</code></a></td></tr></tbody></table><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;">​</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>optionsFunc</code></td><td style="text-align:left;"><a href="./../feature#optionsfunc"><code>OptionsFunc</code></a>&lt;<code>T</code>, <a href="../../../interfaces/features/boards/board.BaseBoard"><code>BaseBoard</code></a>, <a href="./board#genericboard"><code>GenericBoard</code></a>&gt;</td><td style="text-align:left;">Board options.</td></tr></tbody></table><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;">​</a></h4><p><a href="./board#board"><code>Board</code></a>&lt;<code>T</code>&gt;</p><h4 id="defined-in-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L288" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:288</a></p><hr><h3 id="getnodeproperty" tabindex="-1">getNodeProperty <a class="header-anchor" href="#getnodeproperty" aria-label="Permalink to &quot;getNodeProperty&quot;">​</a></h3><p>▸ <strong>getNodeProperty</strong>&lt;<code>T</code>&gt;(<code>property</code>, <code>node</code>): <code>T</code></p><p>Gets the value of a property for a specified node.</p><h4 id="type-parameters-5" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-5" aria-label="Permalink to &quot;Type parameters&quot;">​</a></h4><table><thead><tr><th style="text-align:left;">Name</th></tr></thead><tbody><tr><td style="text-align:left;"><code>T</code></td></tr></tbody></table><h4 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to &quot;Parameters&quot;">​</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>property</code></td><td style="text-align:left;"><a href="./board#nodecomputable"><code>NodeComputable</code></a>&lt;<code>T</code>&gt;</td><td style="text-align:left;">The property to find the value of</td></tr><tr><td style="text-align:left;"><code>node</code></td><td style="text-align:left;"><a href="../../../interfaces/features/boards/board.BoardNode"><code>BoardNode</code></a></td><td style="text-align:left;">The node to get the property of</td></tr></tbody></table><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to &quot;Returns&quot;">​</a></h4><p><code>T</code></p><h4 id="defined-in-10" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-10" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L456" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:456</a></p><hr><h3 id="getuniquenodeid" tabindex="-1">getUniqueNodeID <a class="header-anchor" href="#getuniquenodeid" aria-label="Permalink to &quot;getUniqueNodeID&quot;">​</a></h3><p>▸ <strong>getUniqueNodeID</strong>(<code>board</code>): <code>number</code></p><p>Utility to get an ID for a node that is guaranteed unique.</p><h4 id="parameters-2" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-2" aria-label="Permalink to &quot;Parameters&quot;">​</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>board</code></td><td style="text-align:left;"><a href="./board#genericboard"><code>GenericBoard</code></a></td><td style="text-align:left;">The board feature to generate an ID for</td></tr></tbody></table><h4 id="returns-2" tabindex="-1">Returns <a class="header-anchor" href="#returns-2" aria-label="Permalink to &quot;Returns&quot;">​</a></h4><p><code>number</code></p><h4 id="defined-in-11" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-11" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/boards/board.ts#L464" target="_blank" rel="noreferrer">profectus/src/features/boards/board.ts:464</a></p>',105),c=[r];function l(i,s,n,p,u,h){return a(),t("div",null,c)}const m=e(d,[["render",l]]);export{f as __pageData,m as default};
Reference in a new issue View git blame Copy permalink