Skip to main content

Home > @jsplumbtoolkit/layout-hierarchical > HierarchicalLayout

HierarchicalLayout class

A layout that places vertices into a series of layers.

Signature:

export declare class HierarchicalLayout extends AbstractHierarchicalLayout<HierarchicalLayoutParameters> 

Extends: AbstractHierarchicalLayout<HierarchicalLayoutParameters>

Constructors

ConstructorModifiersDescription
(constructor)(params)Constructs a new instance of the HierarchicalLayout class

Properties

PropertyModifiersTypeDescription
_alignmentstring
_alignmentLocationCalculators{ [x: string]: (cg: any) => any; }
_childGroupsArray<any>
_getChildEdgesFunction
_hierarchyArray<any>
_maxSizesArray<number>
_parentAlignmentCalculators{ center: (cg: any, min: number, max: number) => number; start: (cg: any, min: number, max: number) => number; end: (cg: any, min: number, max: number) => number; }
_visitedNodesRecord<string, any>
compressboolean
invertboolean
orientationHierarchicalLayoutOrientation
spacingstring
typestring
typestaticstring

Methods

MethodModifiersDescription
_id(v)
_setGroupParentLocation(g, loc)
begin(toolkit, parameters)
getDefaultParameters()
getHierarchy()Gets the computed hierarchy. This is returned as an array of objects, one for each level, inside which there is a nodes array.
getOrientation()Gets the orientation of the layout - "horizontal" or "vertical".
getPadding()
step(toolkit, parameters)
vertexRemoved(v, doNotCalculateExtents)