profectus-docs/assets/api_modules_features_boards_board.md.298d230b.js

1 line
22 KiB
JavaScript

import{_ as e,c as t,o as a,a as o}from"./app.ab34650d.js";const f=JSON.parse('{"title":"Module: features/boards/board","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Components","slug":"components"},{"level":2,"title":"Enumerations","slug":"enumerations"},{"level":2,"title":"Interfaces","slug":"interfaces"},{"level":2,"title":"Type Aliases","slug":"type-aliases"},{"level":3,"title":"Board","slug":"board"},{"level":3,"title":"BoardData","slug":"boarddata"},{"level":3,"title":"BoardNodeAction","slug":"boardnodeaction"},{"level":3,"title":"GenericBoard","slug":"genericboard"},{"level":3,"title":"GenericBoardNodeAction","slug":"genericboardnodeaction"},{"level":3,"title":"GenericNodeType","slug":"genericnodetype"},{"level":3,"title":"NodeComputable","slug":"nodecomputable"},{"level":3,"title":"NodeType","slug":"nodetype"},{"level":2,"title":"Variables","slug":"variables"},{"level":3,"title":"BoardType","slug":"boardtype"},{"level":2,"title":"Functions","slug":"functions"},{"level":3,"title":"createBoard","slug":"createboard"},{"level":3,"title":"getNodeProperty","slug":"getnodeproperty"},{"level":3,"title":"getUniqueNodeID","slug":"getuniquenodeid"}],"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-hidden="true">#</a></h1><h2 id="components" tabindex="-1">Components <a class="header-anchor" href="#components" aria-hidden="true">#</a></h2><ul><li><a href="./BoardComponent.html">Board</a></li><li><a href="./BoardLinkComponent.html">BoardLink</a></li><li><a href="./BoardNodeComponent.html">BoardNode</a></li></ul><h2 id="enumerations" tabindex="-1">Enumerations <a class="header-anchor" href="#enumerations" aria-hidden="true">#</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-hidden="true">#</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-hidden="true">#</a></h2><h3 id="board" tabindex="-1">Board <a class="header-anchor" href="#board" aria-hidden="true">#</a></h3><p>\u01AC <strong>Board</strong>&lt;<code>T</code>&gt;: <a href="./../feature.html#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.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;classes&quot;</code>]&gt; ; <code>height</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;height&quot;</code>]&gt; ; <code>style</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;style&quot;</code>]&gt; ; <code>types</code>: <code>Record</code>&lt;<code>string</code>, <a href="./board.html#genericnodetype"><code>GenericNodeType</code></a>&gt; ; <code>visibility</code>: <a href="./../../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;visibility&quot;</code>], <a href="./../../../enums/features/feature.Visibility.html#visible"><code>Visible</code></a>&gt; ; <code>width</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;width&quot;</code>]&gt; }&gt;</p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-hidden="true">#</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-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L180" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:180</a></p><hr><h3 id="boarddata" tabindex="-1">BoardData <a class="header-anchor" href="#boarddata" aria-hidden="true">#</a></h3><p>\u01AC <strong>BoardData</strong>: <code>Object</code></p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-hidden="true">#</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-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L64" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:64</a></p><hr><h3 id="boardnodeaction" tabindex="-1">BoardNodeAction <a class="header-anchor" href="#boardnodeaction" aria-hidden="true">#</a></h3><p>\u01AC <strong>BoardNodeAction</strong>&lt;<code>T</code>&gt;: <a href="./../feature.html#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.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;fillColor&quot;</code>]&gt; ; <code>icon</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;icon&quot;</code>]&gt; ; <code>links</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;links&quot;</code>]&gt; ; <code>tooltip</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;tooltip&quot;</code>]&gt; ; <code>visibility</code>: <a href="./../../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;visibility&quot;</code>], <a href="./../../../enums/features/feature.Visibility.html#visible"><code>Visible</code></a>&gt; }&gt;</p><h4 id="type-parameters-1" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-1" aria-hidden="true">#</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-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L141" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:141</a></p><hr><h3 id="genericboard" tabindex="-1">GenericBoard <a class="header-anchor" href="#genericboard" aria-hidden="true">#</a></h3><p>\u01AC <strong>GenericBoard</strong>: <a href="./../feature.html#replace"><code>Replace</code></a>&lt;<a href="./board.html#board"><code>Board</code></a>&lt;<a href="../../../interfaces/features/boards/board.BoardOptions"><code>BoardOptions</code></a>&gt;, { <code>visibility</code>: <a href="./../../util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt; }&gt;</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L192" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:192</a></p><hr><h3 id="genericboardnodeaction" tabindex="-1">GenericBoardNodeAction <a class="header-anchor" href="#genericboardnodeaction" aria-hidden="true">#</a></h3><p>\u01AC <strong>GenericBoardNodeAction</strong>: <a href="./../feature.html#replace"><code>Replace</code></a>&lt;<a href="./board.html#boardnodeaction"><code>BoardNodeAction</code></a>&lt;<a href="../../../interfaces/features/boards/board.BoardNodeActionOptions"><code>BoardNodeActionOptions</code></a>&gt;, { <code>visibility</code>: <a href="./board.html#nodecomputable"><code>NodeComputable</code></a>&lt;<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt; }&gt;</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L152" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:152</a></p><hr><h3 id="genericnodetype" tabindex="-1">GenericNodeType <a class="header-anchor" href="#genericnodetype" aria-hidden="true">#</a></h3><p>\u01AC <strong>GenericNodeType</strong>: <a href="./../feature.html#replace"><code>Replace</code></a>&lt;<a href="./board.html#nodetype"><code>NodeType</code></a>&lt;<a href="../../../interfaces/features/boards/board.NodeTypeOptions"><code>NodeTypeOptions</code></a>&gt;, { <code>actionDistance</code>: <a href="./board.html#nodecomputable"><code>NodeComputable</code></a>&lt;<code>number</code>&gt; ; <code>canAccept</code>: <a href="./board.html#nodecomputable"><code>NodeComputable</code></a>&lt;<code>boolean</code>&gt; ; <code>draggable</code>: <a href="./board.html#nodecomputable"><code>NodeComputable</code></a>&lt;<code>boolean</code>&gt; ; <code>progressColor</code>: <a href="./board.html#nodecomputable"><code>NodeComputable</code></a>&lt;<code>string</code>&gt; ; <code>progressDisplay</code>: <a href="./board.html#nodecomputable"><code>NodeComputable</code></a>&lt;<a href="../../../enums/features/boards/board.ProgressDisplay"><code>ProgressDisplay</code></a>&gt; ; <code>shape</code>: <a href="./board.html#nodecomputable"><code>NodeComputable</code></a>&lt;<a href="../../../enums/features/boards/board.Shape"><code>Shape</code></a>&gt; ; <code>size</code>: <a href="./board.html#nodecomputable"><code>NodeComputable</code></a>&lt;<code>number</code>&gt; }&gt;</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L114" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:114</a></p><hr><h3 id="nodecomputable" tabindex="-1">NodeComputable <a class="header-anchor" href="#nodecomputable" aria-hidden="true">#</a></h3><p>\u01AC <strong>NodeComputable</strong>&lt;<code>T</code>&gt;: <a href="./../../util/computed.html#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><h4 id="type-parameters-2" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-2" aria-hidden="true">#</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-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L29" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:29</a></p><hr><h3 id="nodetype" tabindex="-1">NodeType <a class="header-anchor" href="#nodetype" aria-hidden="true">#</a></h3><p>\u01AC <strong>NodeType</strong>&lt;<code>T</code>&gt;: <a href="./../feature.html#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.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;actionDistance&quot;</code>], <code>number</code>&gt; ; <code>actions?</code>: <a href="./board.html#genericboardnodeaction"><code>GenericBoardNodeAction</code></a>[] ; <code>canAccept</code>: <a href="./../../util/computed.html#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.html#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.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;fillColor&quot;</code>]&gt; ; <code>label</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;label&quot;</code>]&gt; ; <code>outlineColor</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;outlineColor&quot;</code>]&gt; ; <code>progress</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;progress&quot;</code>]&gt; ; <code>progressColor</code>: <a href="./../../util/computed.html#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.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;progressDisplay&quot;</code>], <a href="./../../../enums/features/boards/board.ProgressDisplay.html#fill"><code>Fill</code></a>&gt; ; <code>shape</code>: <a href="./../../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;shape&quot;</code>], <a href="./../../../enums/features/boards/board.Shape.html#circle"><code>Circle</code></a>&gt; ; <code>size</code>: <a href="./../../util/computed.html#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.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;title&quot;</code>]&gt; ; <code>titleColor</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;titleColor&quot;</code>]&gt; }&gt;</p><h4 id="type-parameters-3" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-3" aria-hidden="true">#</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-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L94" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:94</a></p><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-hidden="true">#</a></h2><h3 id="boardtype" tabindex="-1">BoardType <a class="header-anchor" href="#boardtype" aria-hidden="true">#</a></h3><p>\u2022 <code>Const</code> <strong>BoardType</strong>: typeof <a href="./board.html#boardtype"><code>BoardType</code></a></p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/boards/board.ts#L27" target="_blank" rel="noopener noreferrer">profectus/src/features/boards/board.ts:27</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-hidden="true">#</a></h2><h3 id="createboard" tabindex="-1">createBoard <a class="header-anchor" href="#createboard" aria-hidden="true">#</a></h3><p>\u25B8 <strong>createBoard</strong>&lt;<code>T</code>&gt;(<code>optionsFunc</code>): <a href="./board.html#board"><code>Board</code></a>&lt;<code>T</code>&gt;</p><h4 id="type-parameters-4" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-4" aria-hidden="true">#</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-hidden="true">#</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>optionsFunc</code></td><td style="text-align:left;"><a href="./../feature.html#optionsfunc"><code>OptionsFunc</code></a>&lt;<code>T</code>, <a href="../../../interfaces/features/boards/board.BaseBoard"><code>BaseBoard</code></a>, <a href="./board.html#genericboard"><code>GenericBoard</code></a>&gt;</td></tr></tbody></table><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h4><p><a href="./board.html#board"><code>Board</code></a>&lt;<code>T</code>&gt;</p><hr><h3 id="getnodeproperty" tabindex="-1">getNodeProperty <a class="header-anchor" href="#getnodeproperty" aria-hidden="true">#</a></h3><p>\u25B8 <strong>getNodeProperty</strong>&lt;<code>T</code>&gt;(<code>property</code>, <code>node</code>): <code>T</code></p><h4 id="type-parameters-5" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-5" aria-hidden="true">#</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-hidden="true">#</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>property</code></td><td style="text-align:left;"><a href="./board.html#nodecomputable"><code>NodeComputable</code></a>&lt;<code>T</code>&gt;</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></tr></tbody></table><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-hidden="true">#</a></h4><p><code>T</code></p><hr><h3 id="getuniquenodeid" tabindex="-1">getUniqueNodeID <a class="header-anchor" href="#getuniquenodeid" aria-hidden="true">#</a></h3><p>\u25B8 <strong>getUniqueNodeID</strong>(<code>board</code>): <code>number</code></p><h4 id="parameters-2" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-2" aria-hidden="true">#</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>board</code></td><td style="text-align:left;"><a href="./board.html#genericboard"><code>GenericBoard</code></a></td></tr></tbody></table><h4 id="returns-2" tabindex="-1">Returns <a class="header-anchor" href="#returns-2" aria-hidden="true">#</a></h4><p><code>number</code></p>',87),c=[r];function l(i,s,n,h,p,u){return a(),t("div",null,c)}var m=e(d,[["render",l]]);export{f as __pageData,m as default};