Profectus

Profectus / data/common / LayerTreeNodeOptions

Interface: LayerTreeNodeOptions ​

An object that configures a LayerTreeNode

Extends ​

Properties ​

append? ​

optional append: MaybeRefOrGetter<boolean>

Whether or not to append the layer to the tabs list. If set to false, then the tree node will instead always remove all tabs to its right and then add the layer tab. Defaults to true.

Defined in ​

profectus/src/data/common.tsx:186

canClick? ​

optional canClick: MaybeRefOrGetter<boolean>

Whether or not this tree node can be clicked.

Inherited from ​

TreeNodeOptions.canClick

Defined in ​

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

classes? ​

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

Dictionary of CSS classes to apply to this feature.

Inherited from ​

TreeNodeOptions.classes

Defined in ​

profectus/src/util/vue.tsx:24

color ​

color: MaybeRefOrGetter<string>

The color to display this tree node as

Overrides ​

TreeNodeOptions.color

Defined in ​

profectus/src/data/common.tsx:181

display? ​

optional display: MaybeGetter<Renderable>

The label to display on this tree node.

Inherited from ​

TreeNodeOptions.display

Defined in ​

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

glowColor? ​

optional glowColor: MaybeRefOrGetter<string>

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

Inherited from ​

TreeNodeOptions.glowColor

Defined in ​

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

layerID ​

layerID: string

The ID of the layer this tree node is associated with

Defined in ​

profectus/src/data/common.tsx:179

onClick()? ​

optional onClick: (e?) => void

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

Parameters ​

e? ​

MouseEvent | TouchEvent

Returns ​

void

Inherited from ​

TreeNodeOptions.onClick

Defined in ​

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

onHold? ​

optional onHold: VoidFunction

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

Inherited from ​

TreeNodeOptions.onHold

Defined in ​

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

reset? ​

optional reset: Reset

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

Inherited from ​

TreeNodeOptions.reset

Defined in ​

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

style? ​

optional style: MaybeRefOrGetter<CSSProperties>

CSS to apply to this feature.

Inherited from ​

TreeNodeOptions.style

Defined in ​

profectus/src/util/vue.tsx:26

visibility? ​

optional visibility: MaybeRefOrGetter<boolean | Visibility>

Whether this feature should be visible.

Inherited from ​

TreeNodeOptions.visibility

Defined in ​

profectus/src/util/vue.tsx:22