Profectus

Profectus / features/trees/tree / TreeNodeOptions

Interface: TreeNodeOptions ​

An object that configures a TreeNode.

Extends ​

Extended by ​

Properties ​

canClick? ​

optional canClick: MaybeRefOrGetter<boolean>

Whether or not this tree node can be clicked.

Defined in ​

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

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

color? ​

optional color: MaybeRefOrGetter<string>

The background color for this node.

Defined in ​

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

display? ​

optional display: MaybeGetter<Renderable>

The label to display on this tree node.

Defined in ​

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

glowColor? ​

optional glowColor: MaybeRefOrGetter<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:103

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

onHold? ​

optional onHold: VoidFunction

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

Defined in ​

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

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

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