Skip to main content

BalloonLayoutParameters

Constructor parameters for a Balloon layout.

Extends​

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​

AbstractHierarchicalLayoutParameters.absoluteBacked

getChildEdges​

getChildEdges: ChildEdgesFunction

The function that retrieves child edges for a given vertex. This function defines how the layout walks your data model to generate the output.

getChildVertices?​

optional getChildVertices: HierarchicalLayoutChildVerticesFunction<Vertex>

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

Param​

Param​

Inherited from​

AbstractHierarchicalLayoutParameters.getChildVertices

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[]

Inherited from​

AbstractHierarchicalLayoutParameters.getRootNode

groupPadding?​

optional groupPadding: number

Minimum distance between a group of vertices and its neighbours. Defaults to 100 pixels.

height?​

optional height: number

Optional fixed height for the layout.

Inherited from​

AbstractHierarchicalLayoutParameters.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.

Inherited from​

AbstractHierarchicalLayoutParameters.ignoreLoops

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.

Inherited from​

AbstractHierarchicalLayoutParameters.ignorePorts

locationFunction?​

optional locationFunction: LocationFunction

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

Inherited from​

AbstractHierarchicalLayoutParameters.locationFunction

padding?​

optional padding: PointXY

Optional padding to put around the elements.

Inherited from​

AbstractHierarchicalLayoutParameters.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.

Inherited from​

AbstractHierarchicalLayoutParameters.rootNode

width?​

optional width: number

Optional fixed width for the layout.

Inherited from​

AbstractHierarchicalLayoutParameters.width