Class DirectionNode<Value>

Type Parameters

Value = any

Hierarchy

DirectionNode

Index

Constructors

Properties

_id _layout? _neighbors _nodeFit _paintGroups _rightToLeft _scale _siblings _value?

Methods

connect disconnect id invalidate layout neighbors nodeFit paintGroup paintGroups rightToLeft scale setId setNodeFit setRightToLeft setScale setValue siblings value

Constructors

constructor

new DirectionNode<Value>(value?: Value): DirectionNode<Value>
Type Parameters
- Value = any
Parameters
- Optional value: Value
Returns DirectionNode<Value>
- Defined in DirectionNode/DirectionNode.ts:30

Properties

`Private` _id

_id: string | number

`Private` `Optional` _layout

_layout?: Layout

`Private` _neighbors

_neighbors: Neighbors

`Private` _nodeFit

_nodeFit: Fit

`Private` _paintGroups

_paintGroups: PaintGroups

`Private` _rightToLeft

_rightToLeft: boolean

`Private` _scale

_scale: number

`Private` _siblings

_siblings: Siblings

`Private` `Optional` _value

_value?: Value

Methods

connect

connect(inDirection: Direction, node: DirectionNode<Value>): DirectionNode<Value>
Connects the given node to this node in the specified direction.

If the node already has a parent, it will be disconnected. If this node already has a child in the specified direction, that child will be disconected.

This will invalidate the layout of this node.

Returns
the given node
Parameters
- inDirection: Direction
  
  the direction to attach the given node
- node: DirectionNode<Value>
  
  the node to attach
Returns DirectionNode<Value>
- Defined in DirectionNode/DirectionNode.ts:185

disconnect

disconnect(inDirection?: Direction): DirectionNode<any>
Removes the child in the specified direction.

Returns
the disconnected node, or undefined if no node was disconnected. If this node was to be removed and this node is a root node, this node is returned.
Parameters
- Optional inDirection: Direction
  
  the direction of the child. If undefined, the node to remove is this node from its parent.
Returns DirectionNode<any>
- Defined in DirectionNode/DirectionNode.ts:200

id

id(): string | number
Returns string | number
- Defined in DirectionNode/DirectionNode.ts:90

invalidate

invalidate(): void
Returns void
- Defined in DirectionNode/DirectionNode.ts:65

layout

layout(): Layout
Returns Layout
- Defined in DirectionNode/DirectionNode.ts:51

neighbors

neighbors(): Neighbors
Returns Neighbors
- Defined in DirectionNode/DirectionNode.ts:58

nodeFit

nodeFit(): Fit
Returns Fit
- Defined in DirectionNode/DirectionNode.ts:131

paintGroup

paintGroup(): PaintGroup
Returns
this node's current paint group.

Returns PaintGroup
- Defined in DirectionNode/DirectionNode.ts:169

paintGroups

paintGroups(): PaintGroups
Returns PaintGroups
- Defined in DirectionNode/DirectionNode.ts:162

rightToLeft

rightToLeft(): boolean
Returns boolean
- Defined in DirectionNode/DirectionNode.ts:122

scale

scale(): number
Returns number
- Defined in DirectionNode/DirectionNode.ts:140

setId

setId(id: string | number): DirectionNode<Value>
Parameters
- id: string | number
Returns DirectionNode<Value>
- Defined in DirectionNode/DirectionNode.ts:94

setNodeFit

setNodeFit(nodeFit: Fit): void
Parameters
- nodeFit: Fit
Returns void
- Defined in DirectionNode/DirectionNode.ts:135

setRightToLeft

setRightToLeft(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in DirectionNode/DirectionNode.ts:126

setScale

setScale(scale: number): void
Parameters
- scale: number
Returns void
- Defined in DirectionNode/DirectionNode.ts:144

setValue

setValue(newValue: Value): Value
Sets a new value for this DirectionNode.

The layout is invaidated if the value is changed.

Returns
the new value
Parameters
- newValue: Value
  
  the new value to use
Returns Value
- Defined in DirectionNode/DirectionNode.ts:111

siblings

siblings(): Siblings
Returns Siblings
- Defined in DirectionNode/DirectionNode.ts:155

value

value(): Value
Returns Value
- Defined in DirectionNode/DirectionNode.ts:99

Generated using TypeDoc