Skip to main content

AbstractHierarchicalLayoutParameters

Base parameters for layouts that extend AbstractHierarchicalLayout.

Extends​

Extended by​

Type Parameters​

T​

T extends HasId

Properties​

absoluteBacked?​

optional absoluteBacked: boolean

Defaults to false. If true, then the layout will use any position values found in the data for a given vertex.

Inherited from​

AbsoluteBackedLayoutParameters.absoluteBacked

getChildVertices?​

optional getChildVertices: HierarchicalLayoutChildVerticesFunction<T>

Optional function used to determine the edges to traverse to find children from some node

Param​

Param​

getRootNode()?​

optional getRootNode: (dataSource) => Vertex[]

Optional. A function that is given the data source instance as argument and is expected to return either a single node/group, or an array of nodes/groups, to use as the root(s) for the layout

Parameters​

dataSource​

DataSource

Returns​

Vertex[]

height?​

optional height: number

Optional fixed height for the layout.

Inherited from​

AbsoluteBackedLayoutParameters.height

ignoreLoops?​

optional ignoreLoops: boolean

Defaults to true. If a loop is found during the layout it is usually ignored, unless this is set to true.

ignorePorts?​

optional ignorePorts: boolean

Defaults to false, meaning that ports are taken into account when figuring the list of edges from some vertex. If you set this to true, ports will be ignored and the layout will only consider edges connected directly to each vertex.

locationFunction?​

optional locationFunction: LocationFunction

Optional function that, given some vertex, can provide the x/y location of the vertex on the canvas

Inherited from​

AbsoluteBackedLayoutParameters.locationFunction

padding?​

optional padding: PointXY

Optional padding to put around the elements.

Inherited from​

AbsoluteBackedLayoutParameters.padding

rootNode?​

optional rootNode: Vertex[]

Optional. Defines the nodes/groups to use as the root of the tree. These may be provided as an array of either a node/group id or a node/group object. If this parameter is not specified and multipleRoots is not false then the layout uses the result(s) of the getRootNode function; otherwise it uses the first node/group found in the dataset.

width?​

optional width: number

Optional fixed width for the layout.

Inherited from​

AbsoluteBackedLayoutParameters.width