RootNodeAlignment

A RootNodeAlignment describes how a local root node is arranged in relation to its children.

Inheritance Hierarchy

RootNodeAlignment

Remarks

The actual placement depends on the orientation of the subtree rooted at the current local root node. All descriptions of the provided alignments refer to the top-to-bottom orientation described by DEFAULT. In this case, the subtrees are placed below the local root and the local root is aligned horizontally above them.

Type Details

yfiles module: layout-tree
yfiles-umd modules: layout-orthogonal-compact, layout-orthogonal, layout-tree, layout
Legacy UMD name: yfiles.tree.RootNodeAlignment

Methods

placeParentHorizontal

(rootShape: RotatedSubtreeShape, shapes: IList<Object>, shapeBounds: Rectangle2D, spacing: number)

Moves the shape of the local root to a suitable position relative to the children's shapes.

Remarks

The movement should only be done on the x-axis (horizontally).

This method is called by RotatableNodePlacerBases when they place the subtrees.

Parameters

options - Object
A map of options to pass to the method.

rootShape - RotatedSubtreeShape: the shape of the local root node that will be moved
shapes - IList<Object>: a list of rotated subtree shapes, representing the shapes of the child nodes
shapeBounds - Rectangle2D: accumulated bounds of the shapes of all child nodes
spacing - number: the spacing value that should be used

Constants

ALL

: RootNodeAlignment

An array containing all supported RootNodeAlignments.

CENTER

: RootNodeAlignment

Horizontal RootNodeAlignment at the center of the subtrees.

Remarks

The root node is placed centered above its whole subgraph. To determine the alignment, only INodeLayouts are considered. Node labels are not included although they are also contained in SubtreeShapes.

CENTER_OVER_CHILDREN

: RootNodeAlignment

Horizontal alignment at the center of the children.

Remarks

The root node is placed centered over its direct children. To determine the alignment, only INodeLayouts are considered. Node labels are not included although they are also contained in SubtreeShapes.

LEADING

: RootNodeAlignment

Horizontal RootNodeAlignment left of the children.

Remarks

The local root node leaves a distance specified by the given spacing to the leftmost child. To determine the alignment, only INodeLayouts are considered. Node labels are not included although they are also contained in SubtreeShapes.

LEFT

: RootNodeAlignment

Horizontal RootNodeAlignment at the left side.

Remarks

The root node is placed left aligned with its leftmost child. To determine the alignment, only INodeLayouts are considered. Node labels are not included although they are also contained in SubtreeShapes.

MEDIAN

: RootNodeAlignment

Horizontal RootNodeAlignment at the median child node.

Remarks

The root node is placed above the median of its children. To determine the alignment, only INodeLayouts are considered. Node labels are not included although they are also contained in SubtreeShapes.

This alignment is only suited for ITreeLayoutNodePlacers that place all children in a single row.

RIGHT

: RootNodeAlignment

Horizontal RootNodeAlignment at the right side.

Remarks

The root node is placed right aligned with its rightmost child. To determine the alignment, only INodeLayouts are considered. Node labels are not included although they are also contained in SubtreeShapes.

TRAILING

: RootNodeAlignment

Horizontal RootNodeAlignment right of the children.

Remarks

The root node leaves a distance specified by the given spacing to the rightmost child. To determine the alignment, only INodeLayouts are considered. Node labels are not included although they are also contained in SubtreeShapes.

Static Methods

getBounds

(shapes: IList<Object>) : Rectangle2D

Calculates the common bounds of the given subtree shapes.

Remarks

This method can be used when placing the local root above its subtrees in method placeParentHorizontal.

Parameters

options - Object
A map of options to pass to the method.

shapes - IList<Object>: a list of rotated subtree shapes

Returns

↪Rectangle2D: the rectangle describing the bounds containing all given shapes