Profectus

Profectus / features/trees/tree / TreeOptions

Interface: TreeOptions ​

An object that configures a Tree.

Extends ​

Properties ​

branches? ​

optional branches: MaybeRefOrGetter<TreeBranch[]>

The branches between nodes within this tree.

Defined in ​

profectus/src/features/trees/tree.tsx:128

classes? ​

optional classes: MaybeRefOrGetter<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Inherited from ​

VueFeatureOptions.classes

Defined in ​

profectus/src/util/vue.tsx:24

leftSideNodes? ​

optional leftSideNodes: MaybeRefOrGetter<TreeNode[]>

Nodes to show on the left side of the tree.

Defined in ​

profectus/src/features/trees/tree.tsx:124

nodes ​

nodes: MaybeRefOrGetter<TreeNode[][]>

The nodes within the tree, in a 2D array.

Defined in ​

profectus/src/features/trees/tree.tsx:122

onReset()? ​

optional onReset: (node) => void

A function that is called when a node within the tree is reset.

Parameters ​

node ​

TreeNode

Returns ​

void

Defined in ​

profectus/src/features/trees/tree.tsx:132

resetPropagation? ​

optional resetPropagation: ResetPropagation

How to propagate resets through the tree.

Defined in ​

profectus/src/features/trees/tree.tsx:130

rightSideNodes? ​

optional rightSideNodes: MaybeRefOrGetter<TreeNode[]>

Nodes to show on the right side of the tree.

Defined in ​

profectus/src/features/trees/tree.tsx:126

style? ​

optional style: MaybeRefOrGetter<CSSProperties>

CSS to apply to this feature.

Inherited from ​

VueFeatureOptions.style

Defined in ​

profectus/src/util/vue.tsx:26

visibility? ​

optional visibility: MaybeRefOrGetter<boolean | Visibility>

Whether this feature should be visible.

Inherited from ​

VueFeatureOptions.visibility

Defined in ​

profectus/src/util/vue.tsx:22