Module: features/trees/tree
Interfaces
Type aliases
GenericTree
Ƭ GenericTree: Replace<Tree<TreeOptions>, { visibility: ProcessedComputable<Visibility> }>
Defined in
profectus/src/features/trees/tree.ts:161
GenericTreeNode
Ƭ GenericTreeNode: Replace<TreeNode<TreeNodeOptions>, { canClick: ProcessedComputable<boolean> ; visibility: ProcessedComputable<Visibility> }>
Defined in
profectus/src/features/trees/tree.ts:68
ResetPropagation
Ƭ ResetPropagation: (tree: GenericTree, resettingNode: GenericTreeNode) => void
Type declaration
▸ (tree, resettingNode): void
Parameters
| Name | Type |
|---|---|
tree | GenericTree |
resettingNode | GenericTreeNode |
Returns
void
Defined in
profectus/src/features/trees/tree.ts:210
Tree
Ƭ 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
| Name | Type |
|---|---|
T | extends TreeOptions |
Defined in
profectus/src/features/trees/tree.ts:150
TreeNode
Ƭ 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
| Name | Type |
|---|---|
T | extends TreeNodeOptions |
Defined in
profectus/src/features/trees/tree.ts:53
Variables
TreeNodeType
• Const TreeNodeType: typeof TreeNodeType
Defined in
profectus/src/features/trees/tree.ts:29
TreeType
• Const TreeType: typeof TreeType
Defined in
profectus/src/features/trees/tree.ts:30
Functions
branchedResetPropagation
▸ branchedResetPropagation(tree, resettingNode): void
Parameters
| Name | Type |
|---|---|
tree | GenericTree |
resettingNode | GenericTreeNode |
Returns
void
Defined in
profectus/src/features/trees/tree.ts:236
createResourceTooltip
▸ createResourceTooltip(resource, requiredResource?, requirement?): Ref<string>
Parameters
| Name | Type | Default value |
|---|---|---|
resource | Resource<DecimalSource> | undefined |
requiredResource | null | Resource<DecimalSource> | null |
requirement | Computable<DecimalSource> | 0 |
Returns
Ref<string>
Defined in
profectus/src/features/trees/tree.ts:271
createTree
▸ createTree<T>(optionsFunc): Tree<T>
Type parameters
| Name | Type |
|---|---|
T | extends TreeOptions |
Parameters
| Name | Type |
|---|---|
optionsFunc | () => T & ThisType<Tree<T>> |
Returns
Tree<T>
Defined in
profectus/src/features/trees/tree.ts:168
createTreeNode
▸ createTreeNode<T>(optionsFunc): TreeNode<T>
Type parameters
| Name | Type |
|---|---|
T | extends TreeNodeOptions |
Parameters
| Name | Type |
|---|---|
optionsFunc | () => T & ThisType<TreeNode<T>> |
Returns
TreeNode<T>
Defined in
profectus/src/features/trees/tree.ts:76
defaultResetPropagation
▸ defaultResetPropagation(tree, resettingNode): void
Parameters
| Name | Type |
|---|---|
tree | GenericTree |
resettingNode | GenericTreeNode |
Returns
void
Defined in
profectus/src/features/trees/tree.ts:214
invertedResetPropagation
▸ invertedResetPropagation(tree, resettingNode): void
Parameters
| Name | Type |
|---|---|
tree | GenericTree |
resettingNode | GenericTreeNode |
Returns
void