import{_ as e,c as t,o as r,a}from"./app.8e8712eb.js";const g='{"title":"Module: features/trees/tree","description":"","frontmatter":{},"headers":[{"level":2,"title":"Interfaces","slug":"interfaces"},{"level":2,"title":"Type aliases","slug":"type-aliases"},{"level":3,"title":"GenericTree","slug":"generictree"},{"level":3,"title":"GenericTreeNode","slug":"generictreenode"},{"level":3,"title":"ResetPropagation","slug":"resetpropagation"},{"level":3,"title":"Tree","slug":"tree"},{"level":3,"title":"TreeNode","slug":"treenode"},{"level":2,"title":"Variables","slug":"variables"},{"level":3,"title":"TreeNodeType","slug":"treenodetype"},{"level":3,"title":"TreeType","slug":"treetype"},{"level":2,"title":"Functions","slug":"functions"},{"level":3,"title":"branchedResetPropagation","slug":"branchedresetpropagation"},{"level":3,"title":"createResourceTooltip","slug":"createresourcetooltip"},{"level":3,"title":"createTree","slug":"createtree"},{"level":3,"title":"createTreeNode","slug":"createtreenode"},{"level":3,"title":"defaultResetPropagation","slug":"defaultresetpropagation"},{"level":3,"title":"invertedResetPropagation","slug":"invertedresetpropagation"}],"relativePath":"api/modules/features/trees/tree.md"}',d={},o=a('

Module: features/trees/tree

Interfaces

Type aliases

GenericTree

\u01AC GenericTree: Replace<Tree<TreeOptions>, { visibility: ProcessedComputable<Visibility> }>

Defined in

profectus/src/features/trees/tree.ts:161


GenericTreeNode

\u01AC GenericTreeNode: Replace<TreeNode<TreeNodeOptions>, { canClick: ProcessedComputable<boolean> ; visibility: ProcessedComputable<Visibility> }>

Defined in

profectus/src/features/trees/tree.ts:68


ResetPropagation

\u01AC ResetPropagation: (tree: GenericTree, resettingNode: GenericTreeNode) => void

Type declaration

\u25B8 (tree, resettingNode): void

Parameters
NameType
treeGenericTree
resettingNodeGenericTreeNode
Returns

void

Defined in

profectus/src/features/trees/tree.ts:210


Tree

\u01AC Tree<T>: Replace<T & BaseTree, { branches: GetComputableType<T["branches"]> ; leftSideNodes: GetComputableType<T["leftSideNodes"]> ; nodes: GetComputableType<T["nodes"]> ; rightSideNodes: GetComputableType<T["rightSideNodes"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

Type parameters

NameType
Textends TreeOptions

Defined in

profectus/src/features/trees/tree.ts:150


TreeNode

\u01AC TreeNode<T>: Replace<T & BaseTreeNode, { canClick: GetComputableTypeWithDefault<T["canClick"], true> ; classes: GetComputableType<T["classes"]> ; color: GetComputableType<T["color"]> ; display: GetComputableType<T["display"]> ; glowColor: GetComputableType<T["glowColor"]> ; mark: GetComputableType<T["mark"]> ; style: GetComputableType<T["style"]> ; tooltip: GetComputableType<T["tooltip"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

Type parameters

NameType
Textends TreeNodeOptions

Defined in

profectus/src/features/trees/tree.ts:53

Variables

TreeNodeType

\u2022 Const TreeNodeType: typeof TreeNodeType

Defined in

profectus/src/features/trees/tree.ts:29


TreeType

\u2022 Const TreeType: typeof TreeType

Defined in

profectus/src/features/trees/tree.ts:30

Functions

branchedResetPropagation

\u25B8 branchedResetPropagation(tree, resettingNode): void

Parameters

NameType
treeGenericTree
resettingNodeGenericTreeNode

Returns

void

Defined in

profectus/src/features/trees/tree.ts:236


createResourceTooltip

\u25B8 createResourceTooltip(resource, requiredResource?, requirement?): Ref<string>

Parameters

NameTypeDefault value
resourceResource<DecimalSource>undefined
requiredResourcenull | Resource<DecimalSource>null
requirementComputable<DecimalSource>0

Returns

Ref<string>

Defined in

profectus/src/features/trees/tree.ts:271


createTree

\u25B8 createTree<T>(optionsFunc): Tree<T>

Type parameters

NameType
Textends TreeOptions

Parameters

NameType
optionsFunc() => T & ThisType<Tree<T>>

Returns

Tree<T>

Defined in

profectus/src/features/trees/tree.ts:168


createTreeNode

\u25B8 createTreeNode<T>(optionsFunc): TreeNode<T>

Type parameters

NameType
Textends TreeNodeOptions

Parameters

NameType
optionsFunc() => T & ThisType<TreeNode<T>>

Returns

TreeNode<T>

Defined in

profectus/src/features/trees/tree.ts:76


defaultResetPropagation

\u25B8 defaultResetPropagation(tree, resettingNode): void

Parameters

NameType
treeGenericTree
resettingNodeGenericTreeNode

Returns

void

Defined in

profectus/src/features/trees/tree.ts:214


invertedResetPropagation

\u25B8 invertedResetPropagation(tree, resettingNode): void

Parameters

NameType
treeGenericTree
resettingNodeGenericTreeNode

Returns

void

Defined in

profectus/src/features/trees/tree.ts:225

',106),c=[o];function i(s,n,l,h,f,p){return r(),t("div",null,c)}var b=e(d,[["render",i]]);export{g as __pageData,b as default};