Skip to content
On this page

Interface: LayerTreeNodeOptions

data/common.LayerTreeNodeOptions

An object that configures a LayerTreeNode

Hierarchy

Properties

append

Optional append: Computable<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:190


canClick

Optional canClick: Computable<boolean>

Whether or not this tree node can be clicked.

Inherited from

TreeNodeOptions.canClick

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.

Inherited from

TreeNodeOptions.classes

Defined in

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


color

color: Computable<string>

The color to display this tree node as

Overrides

TreeNodeOptions.color

Defined in

profectus/src/data/common.tsx:180


display

Optional display: Computable<CoercableComponent>

The content to display in the tree node. Defaults to the layer's ID

Overrides

TreeNodeOptions.display

Defined in

profectus/src/data/common.tsx:185


glowColor

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


layerID

layerID: string

The ID of the layer this tree node is associated with

Defined in

profectus/src/data/common.tsx:178


mark

Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Inherited from

TreeNodeOptions.mark

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
NameType
e?MouseEvent | TouchEvent
Returns

void

Inherited from

TreeNodeOptions.onClick

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.

Inherited from

TreeNodeOptions.onHold

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.

Inherited from

TreeNodeOptions.reset

Defined in

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


style

Optional style: Computable<StyleValue>

CSS to apply to this feature.

Inherited from

TreeNodeOptions.style

Defined in

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


visibility

Optional visibility: Computable<boolean | Visibility>

Whether this tree node should be visible.

Inherited from

TreeNodeOptions.visibility

Defined in

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