Profectus

Profectus / data/common / LayerTreeNode

Interface: LayerTreeNode ​

A tree node that is associated with a given layer, and which opens the layer when clicked.

Extends ​

Properties ​

[VueFeature] ​

[VueFeature]: true

Used to identify Vue Features

Inherited from ​

TreeNode.[VueFeature]

Defined in ​

profectus/src/util/vue.tsx:43

append? ​

optional append: MaybeRef<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:197

canClick? ​

optional canClick: MaybeRef<boolean>

Whether or not this tree node can be clicked.

Inherited from ​

TreeNode.canClick

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 ​

TreeNode.classes

Defined in ​

profectus/src/util/vue.tsx:35

color? ​

optional color: MaybeRef<string>

The background color for this node.

Inherited from ​

TreeNode.color

Defined in ​

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

components ​

components: MaybeGetter<Renderable>[]

The components to render inside the vue feature

Inherited from ​

TreeNode.components

Defined in ​

profectus/src/util/vue.tsx:39

display? ​

optional display: MaybeGetter<Renderable>

The label to display on this tree node.

Inherited from ​

TreeNode.display

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.

Inherited from ​

TreeNode.glowColor

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 ​

TreeNode.id

Defined in ​

profectus/src/util/vue.tsx:31

layerID ​

layerID: string

The ID of the layer this tree node is associated with

Defined in ​

profectus/src/data/common.tsx:192

onClick()? ​

optional onClick: (e?) => void

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

Parameters ​

e? ​

MouseEvent | TouchEvent

Returns ​

void

Inherited from ​

TreeNode.onClick

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.

Inherited from ​

TreeNode.onHold

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.

Inherited from ​

TreeNode.reset

Defined in ​

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

style? ​

optional style: MaybeRef<CSSProperties>

CSS to apply to this feature.

Inherited from ​

TreeNode.style

Defined in ​

profectus/src/util/vue.tsx:37

type ​

type: typeof TreeNodeType

A symbol that helps identify features of the same type.

Inherited from ​

TreeNode.type

Defined in ​

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

visibility? ​

optional visibility: MaybeRef<boolean | Visibility>

Whether this feature should be visible.

Inherited from ​

TreeNode.visibility

Defined in ​

profectus/src/util/vue.tsx:33

wrappers ​

wrappers: Wrapper[]

The components to render wrapped around the vue feature

Inherited from ​

TreeNode.wrappers

Defined in ​

profectus/src/util/vue.tsx:41