Interface: TreeNodeOptions ​

features/trees/tree.TreeNodeOptions

An object that configures a TreeNode.

Hierarchy ​

• TreeNodeOptions

  ↳ LayerTreeNodeOptions

Properties ​

canClick ​

• Optional canClick: Computable<boolean>

Whether or not this tree node can be clicked.

Defined in ​

profectus/src/features/trees/tree.ts:40

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

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

color ​

• Optional color: Computable<string>

The background color for this node.

Defined in ​

profectus/src/features/trees/tree.ts:42

display ​

• Optional display: Computable<CoercableComponent>

The label to display on this tree node.

Defined in ​

profectus/src/features/trees/tree.ts:44

glowColor ​

• Optional glowColor: Computable<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.ts:46

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Defined in ​

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

onClick ​

• Optional onClick: (e?: MouseEvent | TouchEvent) => void

Type declaration ​

▸ (e?): void

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

Parameters ​

Returns ​

void

Defined in ​

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

onHold ​

• Optional onHold: VoidFunction

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

Defined in ​

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

reset ​

• Optional reset: GenericReset

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

Defined in ​

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

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

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

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this tree node should be visible.

Defined in ​

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