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('

Module: features/boards/board

Components

Enumerations

Interfaces

Type Aliases

Board

\u01AC Board<T>: Replace<T & BaseBoard, { classes: GetComputableType<T["classes"]> ; height: GetComputableType<T["height"]> ; style: GetComputableType<T["style"]> ; types: Record<string, GenericNodeType> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> ; width: GetComputableType<T["width"]> }>

Type parameters

NameType
Textends BoardOptions

Defined in

profectus/src/features/boards/board.ts:180


BoardData

\u01AC BoardData: Object

Type declaration

NameType
nodesBoardNode[]
selectedActionstring | null
selectedNodenumber | null

Defined in

profectus/src/features/boards/board.ts:64


BoardNodeAction

\u01AC BoardNodeAction<T>: Replace<T & BaseBoardNodeAction, { fillColor: GetComputableType<T["fillColor"]> ; icon: GetComputableType<T["icon"]> ; links: GetComputableType<T["links"]> ; tooltip: GetComputableType<T["tooltip"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

Type parameters

NameType
Textends BoardNodeActionOptions

Defined in

profectus/src/features/boards/board.ts:141


GenericBoard

\u01AC GenericBoard: Replace<Board<BoardOptions>, { visibility: ProcessedComputable<Visibility> }>

Defined in

profectus/src/features/boards/board.ts:192


GenericBoardNodeAction

\u01AC GenericBoardNodeAction: Replace<BoardNodeAction<BoardNodeActionOptions>, { visibility: NodeComputable<Visibility> }>

Defined in

profectus/src/features/boards/board.ts:152


GenericNodeType

\u01AC GenericNodeType: Replace<NodeType<NodeTypeOptions>, { actionDistance: NodeComputable<number> ; canAccept: NodeComputable<boolean> ; draggable: NodeComputable<boolean> ; progressColor: NodeComputable<string> ; progressDisplay: NodeComputable<ProgressDisplay> ; shape: NodeComputable<Shape> ; size: NodeComputable<number> }>

Defined in

profectus/src/features/boards/board.ts:114


NodeComputable

\u01AC NodeComputable<T>: Computable<T> | (node: BoardNode) => T

Type parameters

Name
T

Defined in

profectus/src/features/boards/board.ts:29


NodeType

\u01AC NodeType<T>: Replace<T & BaseNodeType, { actionDistance: GetComputableTypeWithDefault<T["actionDistance"], number> ; actions?: GenericBoardNodeAction[] ; canAccept: GetComputableTypeWithDefault<T["canAccept"], false> ; draggable: GetComputableTypeWithDefault<T["draggable"], false> ; fillColor: GetComputableType<T["fillColor"]> ; label: GetComputableType<T["label"]> ; outlineColor: GetComputableType<T["outlineColor"]> ; progress: GetComputableType<T["progress"]> ; progressColor: GetComputableTypeWithDefault<T["progressColor"], "none"> ; progressDisplay: GetComputableTypeWithDefault<T["progressDisplay"], Fill> ; shape: GetComputableTypeWithDefault<T["shape"], Circle> ; size: GetComputableTypeWithDefault<T["size"], 50> ; title: GetComputableType<T["title"]> ; titleColor: GetComputableType<T["titleColor"]> }>

Type parameters

NameType
Textends NodeTypeOptions

Defined in

profectus/src/features/boards/board.ts:94

Variables

BoardType

\u2022 Const BoardType: typeof BoardType

Defined in

profectus/src/features/boards/board.ts:27

Functions

createBoard

\u25B8 createBoard<T>(optionsFunc): Board<T>

Type parameters

NameType
Textends BoardOptions

Parameters

NameType
optionsFuncOptionsFunc<T, BaseBoard, GenericBoard>

Returns

Board<T>


getNodeProperty

\u25B8 getNodeProperty<T>(property, node): T

Type parameters

Name
T

Parameters

NameType
propertyNodeComputable<T>
nodeBoardNode

Returns

T


getUniqueNodeID

\u25B8 getUniqueNodeID(board): number

Parameters

NameType
boardGenericBoard

Returns

number

',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};