Optional
absoluteDefaults to false. If true, then the layout will use any position values found in the data for a given vertex.
Optional
alignmentOptional, defaults to HierarchyLayoutAlignmentValues.center
. Instructs the layout how to place child nodes with
respect to their parent nodes. By default, a group of child nodes is centered on its parent. The layout also supports "start" and "end" for
this value, which work in much the same way as "flex-start" and "flex-end" do in CSS: for a layout
with the root at the top of the tree and the child nodes underneath, a value of "start" for align would cause the
first child of the root to be placed immediately under the root, with its first child immediately underneath, etc.
The remainder of the content would fan out to the right. This option also works in conjunction with invert and
axis:HierarchyLayoutAxisValues.vertical.
Optional
axisEither horizontal
(the default, groups of child vertices are laid out in rows) or vertical
(groups of child vertices are
laid out in columns)
Optional
edgeOptional filter for edges. If provided, this function will be used to filter the edges that identify links between vertices. All filtered edges are gathered
Optional
gatherIf true root nodes that do not have children will be positioned adjacent to the last root node that does have children. When false (which is the default), unattached roots are spaced apart so that they do not overlap any child trees.
Optional
generateDefaults to false. If true, the layout generates routing information for the channels between layers and edge nodes, and for edge routing.
Optional
getOptional function you can provide that will dynamically be invoked to get the root node to use.
Optional
heightOptional fixed height for the layout.
Optional
invertIf true, the layout will be inverted in its perpendicular axis. For instance, if axis
is "horizontal" and invert
is
true, the root nodes of the layout will be placed at the bottom of the layout, and their children will be placed above them.
Optional
locationOptional function that, given some vertex, can provide the x/y location of the vertex on the canvas
Optional
maxMaximum number of iterations to run. Defaults to 24.
Optional
maxNumber of iterations to try rearranging the graph without an improvement in legibility before accepting the current state. Defaults to 2.
Optional
paddingOptional padding to put around the elements.
Optional
placementThe strategy to use when placing vertices. Default is 'center', meaning every row is centered around the axis orthogonal to the axis in which the vertices are laid out.
Optional
respectIf true, the layout will take into account 'directed' edges, and attempt to place the source of any given edge in a higher layer than the edge's target. This flag also has the effect of positioning any nodes that act only as the source of one or more edges on the root layer of the layout.
It isn't always possible to place the source of some edge in a higher layer than the edge's target, due to the graph's topology, but this flag will ensure the layout makes every effort to do so.
Optional
rootOptional node to use as the root. If this is not provided the layout calculates the best candidate based upon incoming and outgoing edges for each vertex.
Optional
widthOptional fixed width for the layout.
Optional parameters for a Hierarchy layout