Profectus

Profectus / features/trees/tree / Tree

Interface: Tree ​

Extends ​

Properties ​

[VueFeature] ​

[VueFeature]: true

Used to identify Vue Features

Inherited from ​

VueFeature.[VueFeature]

Defined in ​

profectus/src/util/vue.tsx:43

branches? ​

optional branches: MaybeRef<TreeBranch[]>

The branches between nodes within this tree.

Defined in ​

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

classes? ​

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

Dictionary of CSS classes to apply to this feature.

Inherited from ​

VueFeature.classes

Defined in ​

profectus/src/util/vue.tsx:35

components ​

components: MaybeGetter<Renderable>[]

The components to render inside the vue feature

Inherited from ​

VueFeature.components

Defined in ​

profectus/src/util/vue.tsx:39

id ​

id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Inherited from ​

VueFeature.id

Defined in ​

profectus/src/util/vue.tsx:31

isResetting ​

isResetting: Ref<boolean, boolean>

A flag that is true while the reset is still propagating through the tree.

Defined in ​

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

leftSideNodes? ​

optional leftSideNodes: MaybeRef<TreeNode[]>

Nodes to show on the left side of the tree.

Defined in ​

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

links: MaybeRef<Link[]>

The link objects for each of the branches of the tree.

Defined in ​

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

nodes ​

nodes: MaybeRef<TreeNode[][]>

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

Defined in ​

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

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:218

reset() ​

reset: (node) => void

Cause a reset on this node and propagate it through the tree according to TreeOptions.resetPropagation.

Parameters ​

node ​

TreeNode

Returns ​

void

Defined in ​

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

resetPropagation? ​

optional resetPropagation: ResetPropagation

How to propagate resets through the tree.

Defined in ​

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

resettingNode ​

resettingNode: Ref<any, any>

A reference to the node that caused the currently propagating reset.

Defined in ​

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

rightSideNodes? ​

optional rightSideNodes: MaybeRef<TreeNode[]>

Nodes to show on the right side of the tree.

Defined in ​

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

style? ​

optional style: MaybeRef<CSSProperties>

CSS to apply to this feature.

Inherited from ​

VueFeature.style

Defined in ​

profectus/src/util/vue.tsx:37

type ​

type: typeof TreeType

A symbol that helps identify features of the same type.

Defined in ​

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

visibility? ​

optional visibility: MaybeRef<boolean | Visibility>

Whether this feature should be visible.

Inherited from ​

VueFeature.visibility

Defined in ​

profectus/src/util/vue.tsx:33

wrappers ​

wrappers: Wrapper[]

The components to render wrapped around the vue feature

Inherited from ​

VueFeature.wrappers

Defined in ​

profectus/src/util/vue.tsx:41