C

HierarchicalLayoutLayer
expert

Show Usages
This class describes a single layer during a HierarchicalLayout run, most prominently consisting of ordered nodes that are assigned to this layer.
Inheritance Hierarchy

Remarks

It furthermore consists of the associated same-layer edges. Each layer has a type and an index representing its order in the HierarchicalLayoutContext.layers instance that it belongs to.

This class cannot be instantiated

See Also

API

layers, HierarchicalLayout, ILayerAssigner

Members

No filters for this type

Properties

index

: number
readonly
Gets the index of this HierarchicalLayoutLayer instance in the list of all HierarchicalLayoutContext.layers.
readonlyfinal

Property Value

the index of this HierarchicalLayoutLayer instance

nodes

: YList<LayoutNode>
readonly
Gets a list of the LayoutNodes associated with this layer.
readonlyfinal

Property Value

A list of the LayoutNodes of this HierarchicalLayoutLayer

row

: LayoutGridRow
Gets or sets the LayoutGridRow associated with this layer.
final

Property Value

a LayoutGridRow instance or null if none is associated

sameLayerEdges

: YList<LayoutEdge>
readonly
Gets a list of all same-layer LayoutEdges associated with this layer.
readonlyfinal

Property Value

A list of all same-layer LayoutEdges

type

: HierarchicalLayoutLayerType
readonly
Gets the type of this HierarchicalLayoutLayer instance.
readonlyfinal

Property Value

one of the predefined layer types

Methods

add

(node: LayoutNode)
Adds a newly created LayoutNode to this layer.
final

Parameters

node: LayoutNode
the LayoutNode to be added

addSameLayerEdge

(edge: LayoutEdge)
Adds a same-layer LayoutEdge to this layer.
final

Parameters

edge: LayoutEdge
The same-layer LayoutEdge to be added.

remove

(node: LayoutNode)
Removes a LayoutNode from this layer.
final

Parameters

node: LayoutNode
the LayoutNode to be removed

setNodeOrder

(list: YList<LayoutNode>)
Applies the node order of the given list to the LayoutNodes on this layer.
final

Parameters

list: YList<LayoutNode>
The list to which the order is to be adapted