Skip to content
On this page

Interface: BaseTree

features/trees/tree.BaseTree

Properties

[Component]

[Component]: GenericComponent

The Vue component used to render this feature.

Defined in

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


[GatherProps]

[GatherProps]: () => Record<string, unknown>

Type declaration

▸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns

Record<string, unknown>

Defined in

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


id

id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in

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


isResetting

isResetting: Ref<boolean>

A flag that is true while the reset is still propagating through the tree.

Defined in

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


links: Ref<Link[]>

The link objects for each of the branches of the tree.

Defined in

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


reset

reset: (node: GenericTreeNode) => void

Type declaration

▸ (node): void

Cause a reset on this node and propagate it through the tree according to resetPropagation.

Parameters
NameType
nodeGenericTreeNode
Returns

void

Defined in

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


resettingNode

resettingNode: Ref<null | GenericTreeNode>

A reference to the node that caused the currently propagating reset.

Defined in

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


type

type: typeof TreeType

A symbol that helps identify features of the same type.

Defined in

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