Profectus

Profectus / features/trees/tree / TreeNode

Interface: TreeNode ​

The properties that are added onto a processed TreeNodeOptions to create an TreeNode.

Extends ​

Extended by ​

Properties ​

[VueFeature] ​

[VueFeature]: true

Used to identify Vue Features

Inherited from ​

VueFeature.[VueFeature]

Defined in ​

profectus/src/util/vue.tsx:43

canClick? ​

optional canClick: MaybeRef<boolean>

Whether or not this tree node can be clicked.

Defined in ​

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

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

color? ​

optional color: MaybeRef<string>

The background color for this node.

Defined in ​

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

components ​

components: MaybeGetter<Renderable>[]

The components to render inside the vue feature

Inherited from ​

VueFeature.components

Defined in ​

profectus/src/util/vue.tsx:39

display? ​

optional display: MaybeGetter<Renderable>

The label to display on this tree node.

Defined in ​

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

glowColor? ​

optional glowColor: MaybeRef<string>

The color of the glow effect shown to notify the user there's something to do with this node.

Defined in ​

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

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

onClick()? ​

optional onClick: (e?) => void

A function that is called when the tree node is clicked.

Parameters ​

e? ​

MouseEvent | TouchEvent

Returns ​

void

Defined in ​

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

onHold? ​

optional onHold: VoidFunction

A function that is called when the tree node is held down.

Defined in ​

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

reset? ​

optional reset: Reset

A reset object attached to this node, used for propagating resets through the tree.

Defined in ​

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

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 TreeNodeType

A symbol that helps identify features of the same type.

Defined in ​

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

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